update(release): rename 0.41.0 into 0.41.1 #1006
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: "📚 Documentation" | |
| env: | |
| PYTHON_VERSION: "3.11" | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| # This workflow is triggered on: | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - ".github/workflows/documentation.yml" | |
| - "docs/**/*" | |
| - "qgis_deployment_toolbelt/**/*.py" | |
| - pyproject.toml | |
| tags: | |
| - "*" | |
| pull_request: | |
| branches: | |
| - main | |
| paths: | |
| - ".github/workflows/documentation.yml" | |
| - docs/**/* | |
| workflow_dispatch: | |
| jobs: | |
| build-docs: | |
| permissions: | |
| contents: read | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Get source code | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| fetch-tags: true | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| cache: "pip" | |
| cache-dependency-path: pyproject.toml | |
| - name: Install project requirements | |
| run: | | |
| python -m pip install -U pip setuptools wheel | |
| - name: Install project as a package | |
| run: python -m pip install -e . | |
| # this job must run before installing other dependencies to avoid listing everything | |
| - name: Generates dependencies graph page with pipdetree | |
| run: | | |
| python -m pip install -U "pipdeptree<3" | |
| echo -e "\`\`\`{mermaid}" > docs/misc/dependencies.md | |
| pipdeptree --exclude pip,pipdeptree,setuptools,wheel --mermaid >> docs/misc/dependencies.md | |
| echo -e "\`\`\`" >> docs/misc/dependencies.md | |
| # this job must run before installing other dependencies to avoid listing everything | |
| - name: Generates licenses page with pip-licences | |
| run: | | |
| python -m pip install -U "pip-licenses<5" | |
| pip-licenses --format=markdown --with-authors --with-description --with-urls --ignore-packages qgis-deployment-toolbelt --output-file=docs/misc/licenses.md | |
| - name: Install documentation requirements | |
| run: | | |
| python -m pip install -U .[doc] | |
| - name: Build doc using Sphinx | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # required to avoid GH API rate limit | |
| run: sphinx-build -b html -j auto -d docs/_build/cache -q docs docs/_build/html | |
| - name: Save build doc as artifact | |
| uses: actions/upload-artifact@v7 | |
| with: | |
| if-no-files-found: error | |
| name: documentation | |
| path: docs/_build/html/* | |
| retention-days: 30 | |
| deploy-docs: | |
| needs: build-docs | |
| permissions: | |
| id-token: write | |
| pages: write | |
| runs-on: ubuntu-latest | |
| if: ${{ | |
| (github.event_name == 'push' && | |
| (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main') | |
| || (github.event_name == 'workflow_run' && github.event.workflow_run && github.event.workflow_run.conclusion == 'success')) | |
| && github.event.repository.fork != true | |
| }} | |
| steps: | |
| - name: Download artifact | |
| uses: actions/download-artifact@v8 | |
| with: | |
| name: documentation | |
| path: docs/_build/html | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v6 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v4 | |
| with: | |
| name: github-pages | |
| path: docs/_build/html/ | |
| - name: Deploy to GitHub Pages | |
| uses: actions/deploy-pages@v5 | |
| id: deployment |