Update changelog #231
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: Dev Docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| concurrency: | |
| group: docs-deploy | |
| env: | |
| FORCE_COLOR: "1" | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| # Fetch all history for applying timestamps to every page | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.10' | |
| - name: Ensure latest pip | |
| run: python -m pip install --upgrade pip | |
| - name: Install Hatch & pre-commit | |
| run: pip install --upgrade --pre hatch hatch-vcs pre-commit | |
| - name: Initialise default environment | |
| run: hatch run python --version | |
| - name: Configure Git for GitHub Actions bot | |
| run: | | |
| git config --local user.name 'github-actions[bot]' | |
| git config --local user.email 'github-actions[bot]@users.noreply.github.com' | |
| - name: Build documentation | |
| run: hatch run docs:build-check | |
| - name: Commit documentation on gh-pages | |
| run: hatch run docs:ci-build dev | |
| - name: Create archive | |
| run: git archive -o site.zip gh-pages | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| name: docs | |
| path: site.zip | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: | |
| - build | |
| steps: | |
| - name: Download archive | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: docs | |
| - name: Unpack archive | |
| run: python -m zipfile -e site.zip site | |
| - uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: site | |
| commit_message: ${{ github.event.head_commit.message }} | |
| # Write .nojekyll at the root, see: | |
| # https://help.github.com/en/github/working-with-github-pages/about-github-pages#static-site-generators | |
| enable_jekyll: false | |
| # Only deploy if there were changes | |
| allow_empty_commit: false |