Fix dev12 doc build #2407
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Simple workflow for deploying static content to GitHub Pages | |
name: Docs | |
on: | |
# Runs on pushes targeting the default branch | |
push: | |
branches: | |
- main | |
pull_request: | |
branches: | |
- main | |
# Allows you to run this workflow manually from the Actions tab | |
workflow_dispatch: | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
cancel-in-progress: true | |
jobs: | |
build-04: | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
version: | |
[ | |
# For main use the workflow target | |
{ ref: "${{github.ref}}", dest-dir: dev, uv-version: "0.5.13" }, | |
{ ref: "v0.4.0.dev0", dest-dir: "0.4.0.dev0", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev1", dest-dir: "0.4.0.dev1", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev2", dest-dir: "0.4.0.dev2", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev3", dest-dir: "0.4.0.dev3", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev4", dest-dir: "0.4.0.dev4", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev5", dest-dir: "0.4.0.dev5", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev6", dest-dir: "0.4.0.dev6", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev7", dest-dir: "0.4.0.dev7", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev8", dest-dir: "0.4.0.dev8", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev9", dest-dir: "0.4.0.dev9", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev10", dest-dir: "0.4.0.dev10", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev11", dest-dir: "0.4.0.dev11", uv-version: "0.5.11" }, | |
{ ref: "v0.4.0.dev12", dest-dir: "0.4.0.dev12", uv-version: "0.5.11" }, | |
] | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
lfs: "true" | |
ref: ${{ matrix.version.ref }} | |
- uses: astral-sh/setup-uv@v5 | |
with: | |
enable-cache: true | |
version: ${{ matrix.version.uv-version }} | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: "3.11" | |
- run: | | |
uv sync --locked --all-extras | |
source .venv/bin/activate | |
poe --directory ./packages/autogen-core docs-build | |
mkdir -p docs-staging/${{ matrix.version.dest-dir }}/ | |
mv ./packages/autogen-core/docs/build/* docs-staging/${{ matrix.version.dest-dir }}/ | |
working-directory: ./python | |
env: | |
PY_DOCS_DIR: ${{ matrix.version.dest-dir }}/ | |
PY_SWITCHER_VERSION: ${{ matrix.version.dest-dir }} | |
- uses: actions/upload-artifact@v4 | |
with: | |
path: "./python/docs-staging" | |
name: "${{ matrix.version.dest-dir }}-docs" | |
gen-redirects: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
lfs: "true" | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: "3.11" | |
- name: generate redirects | |
run: | | |
mkdir -p python/docs-staging/ | |
python python/packages/autogen-core/docs/redirects/redirects.py python/docs-staging | |
- uses: actions/upload-artifact@v4 | |
with: | |
path: "./python/docs-staging" | |
name: "redirects" | |
gen-component-schema: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
lfs: "true" | |
ref: ${{ matrix.version.ref }} | |
- uses: astral-sh/setup-uv@v5 | |
with: | |
enable-cache: true | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: "3.11" | |
- run: | | |
uv sync --locked --all-extras | |
source .venv/bin/activate | |
mkdir -p docs-staging/schemas/ | |
gen-component-schema > docs-staging/schemas/component-schema-latest.json | |
working-directory: ./python | |
- uses: actions/upload-artifact@v4 | |
with: | |
path: "./python/docs-staging" | |
name: "component-schema" | |
build-02: | |
runs-on: ubuntu-latest | |
defaults: | |
run: | |
working-directory: website | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
lfs: true | |
ref: "0.2" | |
- uses: actions/setup-node@v4 | |
with: | |
node-version: 18.x | |
- name: setup python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.8" | |
- name: pydoc-markdown install | |
run: | | |
python -m pip install --upgrade pip | |
pip install pydoc-markdown pyyaml termcolor | |
# Pin databind packages as version 4.5.0 is not compatible with pydoc-markdown. | |
pip install databind.core==4.4.2 databind.json==4.4.2 | |
- name: pydoc-markdown run | |
run: | | |
pydoc-markdown | |
- name: quarto install | |
working-directory: ${{ runner.temp }} | |
run: | | |
wget -q https://github.com/quarto-dev/quarto-cli/releases/download/v1.5.23/quarto-1.5.23-linux-amd64.tar.gz | |
tar -xzf quarto-1.5.23-linux-amd64.tar.gz | |
echo "$(pwd)/quarto-1.5.23/bin/" >> $GITHUB_PATH | |
- name: Process notebooks | |
run: | | |
python process_notebooks.py render | |
- name: Build website | |
run: | | |
if [ -e yarn.lock ]; then | |
yarn install --frozen-lockfile --ignore-engines | |
yarn build | |
elif [ -e package-lock.json ]; then | |
npm ci | |
npm run build | |
else | |
npm i --legacy-peer-deps | |
npm run build | |
fi | |
- run: | | |
mkdir -p artifact/0.2/ | |
cp -r build/* artifact/0.2/ | |
- uses: actions/upload-artifact@v4 | |
with: | |
path: "website/artifact" | |
name: "02-docs" | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: [build-02, build-04, gen-redirects, gen-component-schema] | |
if: ${{ needs.build-02.result == 'success' && needs.build-04.result == 'success' && needs.gen-redirects.result == 'success' && github.ref == 'refs/heads/main' }} | |
steps: | |
- uses: actions/download-artifact@v4 | |
with: | |
path: artifacts | |
- name: Copy 02-docs | |
run: | | |
mkdir -p deploy/ | |
for dir in artifacts/*; do | |
cp -r $dir/* deploy/ | |
done | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: "./deploy" | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |