diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 7ddccf79..92d427a9 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,21 +1,36 @@ -name: ci +# Simple workflow for deploying static content to GitHub Pages +name: Docs + on: + # Runs on pushes targeting the default branch push: - branches: - - master - - main - - docs + branches: ["main", "docs"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages permissions: - contents: write + 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: + # Single deploy job since we're just deploying deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - - name: Configure Git Credentials - run: | - git config user.name github-actions[bot] - git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - name: Checkout + uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: python-version: 3.x @@ -27,4 +42,14 @@ jobs: restore-keys: | mkdocs-material- - run: pip install mkdocs-material - - run: mkdocs gh-deploy --force \ No newline at end of file + - run: mkdocs build + - name: Setup Pages + uses: actions/configure-pages@v4 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: 'site' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4