ci(docs): manual, main-only docs deploy on demand - #488
Open
JasonVranek wants to merge 1 commit into
Open
Conversation
Replace the abandoned `stable`-branch deploy (frozen at v0.9.3) with a manual (`workflow_dispatch`) GitHub Pages deploy. Publishing is restricted to `main` by two independent layers: the `github-pages` environment's deployment-branch policy (set to `main` only), and a guard step that fails the run if dispatched from any other ref. So "only what's reviewed and merged to main is published" holds even though workflow_dispatch's branch picker technically offers other branches. Manual (not push-triggered) so publishing is a deliberate act and a failed run can be re-fired without a new commit if the runner is unavailable. test-docs runs the build on any PR touching docs or their linked inputs (filter covers `config.example.toml`, drops `api/**` — the API spec is fetched client-side at runtime, not built in).
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.
Replace the abandoned
stable-branch deploy (frozen at v0.9.3) with a Pages deploy that publishes the docs on themainbranch.The deploy is manual (
workflow_dispatch), not push-triggered which has caused issues in the past.test-docs runs the build on any PR that touches the docs or their linked inputs, so breakage is caught before merge.