Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork8.4k
✨ Pass none instead of the default value for optional parameters when null is received#21569
Workflow file for this run
This file contains hidden or 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
| name:Build Docs | |
| on: | |
| push: | |
| branches: | |
| -master | |
| pull_request: | |
| types: | |
| -opened | |
| -synchronize | |
| env: | |
| UV_SYSTEM_PYTHON:1 | |
| jobs: | |
| changes: | |
| runs-on:ubuntu-latest | |
| # Required permissions | |
| permissions: | |
| pull-requests:read | |
| # Set job outputs to values from filter step | |
| outputs: | |
| docs:${{ steps.filter.outputs.docs }} | |
| steps: | |
| -uses:actions/checkout@v6 | |
| # For pull requests it's not necessary to checkout the code but for the main branch it is | |
| -uses:dorny/paths-filter@v3 | |
| id:filter | |
| with: | |
| filters:| | |
| docs: | |
| - README.md | |
| - docs/** | |
| - docs_src/** | |
| - requirements-docs.txt | |
| - pyproject.toml | |
| - mkdocs.yml | |
| - mkdocs.env.yml | |
| - .github/workflows/build-docs.yml | |
| - .github/workflows/deploy-docs.yml | |
| - scripts/mkdocs_hooks.py | |
| langs: | |
| needs: | |
| -changes | |
| runs-on:ubuntu-latest | |
| outputs: | |
| langs:${{ steps.show-langs.outputs.langs }} | |
| steps: | |
| -uses:actions/checkout@v6 | |
| -name:Set up Python | |
| uses:actions/setup-python@v6 | |
| with: | |
| python-version:"3.11" | |
| -name:Setup uv | |
| uses:astral-sh/setup-uv@v7 | |
| with: | |
| version:"0.4.15" | |
| enable-cache:true | |
| cache-dependency-glob:| | |
| requirements**.txt | |
| pyproject.toml | |
| -name:Install docs extras | |
| run:uv pip install -r requirements-docs.txt | |
| -name:Verify Docs | |
| run:python ./scripts/docs.py verify-docs | |
| -name:Export Language Codes | |
| id:show-langs | |
| run:| | |
| echo "langs=$(python ./scripts/docs.py langs-json)" >> $GITHUB_OUTPUT | |
| build-docs: | |
| needs: | |
| -changes | |
| -langs | |
| if:${{ needs.changes.outputs.docs == 'true' }} | |
| runs-on:ubuntu-latest | |
| strategy: | |
| matrix: | |
| lang:${{ fromJson(needs.langs.outputs.langs) }} | |
| steps: | |
| -name:Dump GitHub context | |
| env: | |
| GITHUB_CONTEXT:${{ toJson(github) }} | |
| run:echo "$GITHUB_CONTEXT" | |
| -uses:actions/checkout@v6 | |
| -name:Set up Python | |
| uses:actions/setup-python@v6 | |
| with: | |
| python-version:"3.11" | |
| -name:Setup uv | |
| uses:astral-sh/setup-uv@v7 | |
| with: | |
| version:"0.4.15" | |
| enable-cache:true | |
| cache-dependency-glob:| | |
| requirements**.txt | |
| pyproject.toml | |
| -name:Install docs extras | |
| run:uv pip install -r requirements-docs.txt | |
| -name:Update Languages | |
| run:python ./scripts/docs.py update-languages | |
| -uses:actions/cache@v4 | |
| with: | |
| key:mkdocs-cards-${{ matrix.lang }}-${{ github.ref }} | |
| path:docs/${{ matrix.lang }}/.cache | |
| -name:Build Docs | |
| run:python ./scripts/docs.py build-lang ${{ matrix.lang }} | |
| -uses:actions/upload-artifact@v5 | |
| with: | |
| name:docs-site-${{ matrix.lang }} | |
| path:./site/** | |
| include-hidden-files:true | |
| # https://github.com/marketplace/actions/alls-green#why | |
| docs-all-green:# This job does nothing and is only used for the branch protection | |
| if:always() | |
| needs: | |
| -build-docs | |
| runs-on:ubuntu-latest | |
| steps: | |
| -name:Decide whether the needed jobs succeeded or failed | |
| uses:re-actors/alls-green@release/v1 | |
| with: | |
| jobs:${{ toJSON(needs) }} | |
| allowed-skips:build-docs |