ci: bootstrap the docs deploy workflow on the default branch - #633
Merged
Conversation
GitHub registers workflow_dispatch only for workflows present on the default branch. This is a byte-identical copy of the docs.yml shipping on v2 (the docs-site PR): it deploys the v2 documentation site, so on main every trigger is inert except workflow_dispatch, which exists so the workflow can be manually dispatched with --ref v2. No other main content is touched.
apackeer
requested review from
a team,
Kalindi-Dev,
harmjeff,
leandrodamascena,
raj-jain-aws,
scottschreckengaust and
spraja08
July 22, 2026 09:43
leandrodamascena
approved these changes
Jul 22, 2026
raj-jain-aws
approved these changes
Jul 22, 2026
raj-jain-aws
left a comment
raj-jain-aws
left a comment
Contributor
There was a problem hiding this comment.
This is a low-risk, well-constructed change. Single file addition (.github/workflows/docs.yml), nothing else touched. The rationale is sound: planting the workflow on main is the only way GitHub will register workflow_dispatch so the v2 docs deploy can be manually triggered.
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
3 participants
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.
What
Prerequisite for #630 (the v2 Zensical documentation site): a byte-identical copy of that PR's
.github/workflows/docs.ymladded tomain.Why
GitHub registers
workflow_dispatchonly for workflows that exist on the default branch (main). Without this file on main, the docs workflow cannot be manually dispatched at all (gh workflow run docs.yml --ref v2errors with "workflow not found"), which is needed to trigger the first deployment after the admin flips the Pages source to "GitHub Actions" - review feedback on #630.Behavior on main
Inert except for dispatch registration:
push/pull_requesttriggers are scoped tov2, so nothing runs on main's own pushes or PRs--ref v2checks out and builds the v2 docs; a dispatch against main would fail fast at the build step (main has nozensical.toml/pyproject.toml), and deploys are additionally inert until the Pages source is switchedNo other content on main is touched. Merge this before or together with #630; it has no effect on the currently served Jekyll site either way.
Testing
actionlint clean; the workflow content itself is exercised end to end in #630 (strict build + deploy path verified on a fork preview).