chore: fix minor typos #554
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 Documentation | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| release: | |
| types: [published] | |
| # disable permissions for all of the available permissions | |
| permissions: {} | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build-docs: | |
| permissions: | |
| contents: write # for mike to push | |
| name: Deploy Docs through mike | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| with: | |
| persist-credentials: true | |
| - name: Install uv and Python 🐍 | |
| uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0 | |
| with: | |
| activate-environment: true | |
| python-version: '3.13' | |
| - name: Install dependencies | |
| run: | | |
| uv pip install -r docs/requirements-docs.txt | |
| - name: Fetch gh-pages branch | |
| run: | | |
| git fetch origin gh-pages --depth=1 | |
| - name: Configure Git user | |
| run: | | |
| git config --local user.email "github-actions[bot]@users.noreply.github.com" | |
| git config --local user.name "github-actions[bot]" | |
| - name: Build and push Mike | |
| if: ${{ github.event_name == 'push' }} | |
| run: | | |
| mike deploy ${REF_NAME} latest --push --update-aliases | |
| env: | |
| REF_NAME: ${{ github.ref_name }} | |
| - name: Build and push Mike - Release | |
| if: ${{ github.event_name == 'release' }} | |
| run: | | |
| mike deploy ${REF_NAME} stable --push --update-aliases | |
| env: | |
| REF_NAME: ${{ github.ref_name }} | |
| - name: Show mike versions | |
| run: | | |
| mike list |