ci: dispatch the docs API-reference bump on release#31
Merged
Conversation
After a successful PyPI publish, fire a repository_dispatch (sdk-release, payload: version) at glassflow/argus-docs; its bump-api-reference workflow opens the pin-bump + regenerated-reference PR. Skips gracefully until DOCS_DISPATCH_TOKEN is configured (a fine-grained PAT with contents:write on argus-docs; GITHUB_TOKEN cannot dispatch cross-repo) — the docs side has a weekly scheduled fallback either way.
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.
Sending half of the release-to-docs automation; the receiving workflow is glassflow/argus-docs PR #10.
New
dispatch-docsjob in the release workflow: after the PyPI publish succeeds, POST arepository_dispatch(sdk-release, payload{version}) at argus-docs, whosebump-api-referenceworkflow bumps the pin, regenerates the reference, and opens the review PR. Ordering matters: the docs workflow pip-installs the released version, so this only fires from a job thatneeds: publish.Like the Slack notify job, it skips gracefully while its secret is unset, so this merges safely before the token exists.
Setup required (one-time)
repository_dispatch), and store it as theDOCS_DISPATCH_TOKENsecret in this repo.Until then, the docs side's Monday scheduled run covers new releases with up to a week of lag.