ci(docs): redeploy when the lock changes, and allow manual dispatch - #19
Merged
Merged
Conversation
The site is built with `uv sync --group docs`, so what it ships is decided by uv.lock -- but uv.lock was not a trigger path. A dependency fix could land on main while the deployed site kept serving the previous build, with no way to force a rebuild: there was no workflow_dispatch either. That is not hypothetical. mkdocs-material 9.7.6 (GHSA-xvg9-69gf-fjrf, DOM XSS in search suggestions) was live on the published docs, and merging the 9.7.7 bump alone would have closed the alert while leaving the vulnerable build served. orlab's docs workflow already has the right shape: no path filter plus workflow_dispatch.
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
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.
The gap
The docs site is built with
uv sync --group docs, so what it ships is decided byuv.lock— butuv.lockandpyproject.tomlwere not trigger paths. A dependency fix could land onmainwhile the deployed site kept serving the previous build, and there was noworkflow_dispatch, so it could not be rebuilt by hand either.Not hypothetical
mkdocs-material 9.7.6— GHSA-xvg9-69gf-fjrf / CVE-2026-73295, DOM XSS in search suggestions, patched in 9.7.7 — was live on the published docs:The advisory is scoped
development, which understates it here: the vulnerable code is in the search bundle that the public site serves.Merging #16 alone would have closed the Dependabot alert and left that build served — a green signal that did not match what was deployed.
After #16, a fresh strict build from the updated lock
The change
Adds
uv.lockandpyproject.tomlto both trigger lists, and addsworkflow_dispatch. Because.github/workflows/docs.ymlis itself a trigger path, merging this redeploys the site, which is what actually gets 9.7.7 in front of readers.orlab's docs workflow already has the right shape — no path filter plusworkflow_dispatch— so this brings gerberdiff in line with the sibling rather than inventing a convention.