fix(ci): pin mkdocs-monorepo-plugin to a commit SHA and split Pages deploy - #173
Open
nouraellm wants to merge 1 commit into
Open
fix(ci): pin mkdocs-monorepo-plugin to a commit SHA and split Pages deploy#173nouraellm wants to merge 1 commit into
nouraellm wants to merge 1 commit into
Conversation
…eploy Why CI and the Dockerfile install `PauloASilva/mkdocs-monorepo-plugin@feat/i18n` (mutable branch) and CI then runs `mkdocs gh-deploy --force` with `contents: write`. What - Add `requirements.txt` pinning `mkdocs-material==9.0.9` and the plugin to `63f18e2f87aead69883745a0a4808c275005b0f7`. - Point `Dockerfile` at that file. - Split the workflow: `build` (`contents: read`, `mkdocs build`) and `deploy` (`pages: write`, `id-token: write`, `actions/deploy-pages`). - Pin Actions by SHA. Maintainer note `actions/deploy-pages` needs **Settings → Pages → Source = GitHub Actions**. I cannot change that from a fork. Please flip it before or when merging, or the first deploy will fail while the repo is still on branch/`gh-pages`. If `feat/i18n` must move later, bump the SHA in `requirements.txt` in a reviewed commit; do not restore a branch ref. fixes OWASP#168
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
CI and the Dockerfile install
PauloASilva/mkdocs-monorepo-plugin@feat/i18n(mutable branch) and CI then runsmkdocs gh-deploy --forcewithcontents: write.What
requirements.txtpinningmkdocs-material==9.0.9and the plugin to63f18e2f87aead69883745a0a4808c275005b0f7.Dockerfileat that file.build(contents: read,mkdocs build) anddeploy(pages: write,id-token: write,actions/deploy-pages).Maintainer note
actions/deploy-pagesneeds Settings → Pages → Source = GitHub Actions. I cannot change that from a fork. Please flip it before or when merging, or the first deploy will fail while the repo is still on branch/gh-pages. Iffeat/i18nmust move later, bump the SHA inrequirements.txtin a reviewed commit; do not restore a branch ref.fixes #168