Deploy documentation #15
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
| name: Deploy documentation | |
| on: | |
| # Runs on version tags pushes | |
| push: | |
| tags: | |
| - 'v*' | |
| # Runs on manual triggers | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| cache: "pip" | |
| - name: Install uv | |
| run: | | |
| # https://github.com/astral-sh/uv/issues/1386#issuecomment-1947801083 | |
| echo "VIRTUAL_ENV=${Python_ROOT_DIR}" >> $GITHUB_ENV | |
| pip install uv | |
| - name: Install dependencies | |
| run: | | |
| # FIXME: https://github.com/Qiskit/qiskit_sphinx_theme/issues/567 | |
| echo 'furo==2023.9.10' > furo-override.txt | |
| uv pip compile pyproject.toml --all-extras --override furo-override.txt > requirements.txt | |
| uv pip sync --strict requirements.txt | |
| uv pip install --editable . | |
| - name: Check version numbers consistency | |
| run: poe version_check | |
| - name: Build documentation | |
| run: poe docs | |
| # - name: Setup Pages | |
| # uses: actions/configure-pages@v4 | |
| # - name: Upload artifact | |
| # uses: actions/upload-pages-artifact@v3 | |
| # with: | |
| # path: 'docs/_build' | |
| # - name: Deploy to GitHub Pages | |
| # id: deployment | |
| # uses: actions/deploy-pages@v4 |