diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 4837b11..1e5d751 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -1,29 +1,42 @@ name: Documentation on: - push: - branches: - - main - paths: - - "*.md" - - docs/** 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: build-doc: runs-on: ubuntu-latest + environment: + name: github-pages + steps: - - uses: actions/checkout@v2 - - uses: pdm-project/setup-pdm@v2 + - uses: actions/checkout@v4 + - uses: pdm-project/setup-pdm@v4 with: python-version: 3.10.5 - name: Build pages run: | pdm install --group doc cd docs && pdm run mkdocs build - - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs/site + path: './docs/site' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4