Repository navigation
ci(release): dispatch the docs deploy on the staged release branch - #193
Merged
Merged
Conversation
prepare-release.yml pushes release/vX.Y.Z with GITHUB_TOKEN, and GitHub does not start workflows from GITHUB_TOKEN pushes, so docs.yml's `push: release/**` trigger never fired for a staged release. Dispatch docs.yml on the new branch right after pushing it (workflow_dispatch is the documented exception), which needs `actions: write`. CONTRIBUTING: drop the manual "run Deploy docs" step, add the github-pages environment's gh-pages deployment branch to the cutover (branch-based Pages builds still deploy through that environment, so it must not be deleted), and record that the cutover is done. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Description
Makes a stable release's docs publish automatically when
prepare-release.ymlstages its branch.prepare-release.ymlpushesrelease/vX.Y.ZwithGITHUB_TOKEN, and GitHub doesn't start workflow runs fromGITHUB_TOKENpushes. So thepush: release/**trigger added todocs.ymlin #191 never fires for a staged release, and the docs needed a manual Deploy docs run. This PR adds a step right after the branch push that runsgh workflow run docs.yml --ref release/vX.Y.Z.workflow_dispatchis the documented exception thatGITHUB_TOKENcan trigger. The job gainsactions: writefor it.It also fixes the cutover notes in
CONTRIBUTING.md:github-pagesenvironment must be kept. The guide said it could be deleted, but branch-based Pages builds (pages-build-deployment) still deploy through it. During the cutover,gh-pageshad to be added to its deployment branches, because onlymainwas allowed.2.5.0(latest) and3.0.0a2(alpha) are live, and the new Protect gh-pages ruleset blocks deleting and force-pushinggh-pages.Only the comments in
docs.ymlchange, to say thatprepare-release.ymldispatches it.Related Issues
Follow-up to #191.
Type of Change
Checklist
developbranch (only release PRs targetmain)feat:,fix:,refactor:, etc.) — they become the changelogCHANGELOG.mdby hand (it is generated from commit messages)README.md,docs/,examples/) if user-facing behavior changeduv run pytest tests/): no Python changes; required checks will confirmuv run ruff check src/ tests/anduv run ruff format --check src/ tests/): no Python changes; required checks will confirmuv run ty check src/swgoh_comlink/): no Python changes; required checks will confirmTesting
actionlintpasses onprepare-release.ymlanddocs.yml.docs.yml's job condition (swgoh-utils/comlink-python,refs/heads/release/*) anddocs_version.py. Run 39131420131 onrelease/v3.0.0a2published3.0.0a2asalphathrough thegh-pagesruleset.prepare release. Check its job summary and the Deploy docs run it starts.🤖 Generated with Claude Code