✨ docs deployment

Author: juftin

.github/workflows/release.yaml

@@ -33,7 +33,11 @@ jobs:
         needs: release
         if: github.repository_owner == 'juftin'
         permissions:
-            contents: write
+            pages: write
+            id-token: write
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
         steps:
             - name: Checkout Latest Changes
               uses: actions/checkout@v4
@@ -46,12 +50,19 @@ jobs:
                   python-version: "3.11"
             - name: Install Hatch
               run: |
-                  python -m pip install --upgrade pip
+                  python -m pip install --upgrade pip wheel
                   python -m pip install -q hatch pre-commit
                   hatch --version
-            - name: Set Up GitHub Actions User
-              run: |
-                  git config user.name "github-actions[bot]"
-                  git config user.email "github-actions[bot]@users.noreply.github.com"
-            - name: Deploy Documentation Changes
-              run: hatch run docs:deploy --force
+            - name: Create Virtual Environment
+              run: hatch env create docs
+            - name: Build Site
+              run: hatch run docs:build
+            - name: Setup GitHub Pages
+              uses: actions/configure-pages@v4
+            - name: Upload Artifact
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  path: site/
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4

mkdocs.yaml

@@ -31,7 +31,7 @@ repo_name: cookiecutter-python
 edit_uri: blob/main/docs/
 site_author: juftin
 remote_branch: gh-pages
-copyright: Copyright © 2023 Justin Flannery
+copyright: Copyright © 2024 Justin Flannery
 extra:
     generator: false
 markdown_extensions:

tests/example-project/.github/workflows/release.yaml

@@ -46,7 +46,11 @@ jobs:
         needs: release
         if: github.ref == 'refs/heads/main' && github.repository_owner == 'juftin'
         permissions:
-            contents: write
+            pages: write
+            id-token: write
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
         steps:
             - name: Checkout Latest Changes
               uses: actions/checkout@v4
@@ -62,9 +66,16 @@ jobs:
                   python -m pip install --upgrade pip wheel
                   python -m pip install -q hatch pre-commit
                   hatch --version
-            - name: Set Up GitHub Actions User
-              run: |
-                  git config user.name "github-actions[bot]"
-                  git config user.email "github-actions[bot]@users.noreply.github.com"
-            - name: Deploy Documentation Changes
-              run: hatch run docs:gh-deploy --force
+            - name: Create Virtual Environment
+              run: hatch env create docs
+            - name: Build Site
+              run: hatch run docs:build
+            - name: Setup GitHub Pages
+              uses: actions/configure-pages@v4
+            - name: Upload Artifact
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  path: site/
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4

tests/example-project/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright © 2023 Justin Flannery
+Copyright © 2024 Justin Flannery
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

tests/example-project/mkdocs.yaml

@@ -32,7 +32,7 @@ repo_name: example-project
 edit_uri: blob/main/docs/
 site_author: juftin
 remote_branch: gh-pages
-copyright: Copyright © 2023 Justin Flannery
+copyright: Copyright © 2024 Justin Flannery
 extra:
     generator: false
 exclude_docs: |

{{cookiecutter.repo_name}}/.github/workflows/release.yaml

@@ -46,7 +46,11 @@ jobs:
         needs: release
         if: github.ref == 'refs/heads/{{ cookiecutter.default_branch }}' && github.repository_owner == '{{ cookiecutter.github_username }}'
         permissions:
-            contents: write
+            pages: write
+            id-token: write
+        environment:
+            name: github-pages
+            url: ${{"{{"}} steps.deployment.outputs.page_url {{"}}"}}
         steps:
             - name: Checkout Latest Changes
               uses: actions/checkout@v4
@@ -62,9 +66,16 @@ jobs:
                   python -m pip install --upgrade pip wheel
                   python -m pip install -q hatch pre-commit
                   hatch --version
-            - name: Set Up GitHub Actions User
-              run: |
-                  git config user.name "github-actions[bot]"
-                  git config user.email "github-actions[bot]@users.noreply.github.com"
-            - name: Deploy Documentation Changes
-              run: hatch run docs:gh-deploy --force
+            - name: Create Virtual Environment
+              run: hatch env create docs
+            - name: Build Site
+              run: hatch run docs:build
+            - name: Setup GitHub Pages
+              uses: actions/configure-pages@v4
+            - name: Upload Artifact
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  path: site/
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4