diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 4fdee71..92d3476 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,28 +1,43 @@ -name: Deploy Docs to GitHub Pages +# Simple workflow for deploying static content to GitHub Pages +name: Deploy docs to Pages on: + # Runs on pushes targeting the default branch push: - branches: - - main # Set this to your default branch - pull_request: - branches: - - main # Set this to your default branch + branches: ["main"] + + # 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: 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 - permissions: - contents: write steps: - - name: Checkout code - uses: actions/checkout@v3 - - - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v3 + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs - publish_branch: main # Deploy directly to the main branch - user_name: 'github-actions[bot]' - user_email: 'github-actions[bot]@users.noreply.github.com' - commit_message: 'Deploy docs to GitHub Pages' \ No newline at end of file + # Upload only the docs directory + path: './docs' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4