Commit 4716087
committed
ci: Refactor documentation deployment workflow for GitHub Pages
This commit updates the documentation deployment workflow (`docs.yml`) to align with current best practices for deploying to GitHub Pages.
- **Permissions:** Added `pages: write` and `id-token: write` permissions, which are required for modern GitHub Pages deployments.
- **Git Configuration:** Added a step to configure the Git user name and email for the `github-actions[bot]`.
- **Deployment Steps:** The deployment process has been split into two distinct steps:
1. `mkdocs build --strict`: Builds the MkDocs site. The `--strict` flag ensures the build fails on any warnings.
2. `mkdocs gh-deploy --force --clean --verbose`: Deploys the built site to GitHub Pages, cleaning the target branch before deployment and providing verbose output.1 parent 66e35b3 commit 4716087
1 file changed
+13
-2
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| 13 | + | |
| 14 | + | |
13 | 15 | | |
14 | 16 | | |
15 | 17 | | |
| |||
20 | 22 | | |
21 | 23 | | |
22 | 24 | | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
23 | 30 | | |
24 | 31 | | |
25 | 32 | | |
| |||
37 | 44 | | |
38 | 45 | | |
39 | 46 | | |
40 | | - | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
41 | 52 | | |
42 | | - | |
| 53 | + | |
0 commit comments