ci(docs): add workflow_dispatch and Pages concurrency to docs deploy#169
Merged
Conversation
Allow the docs site to be redeployed manually via the Actions UI, and serialize Pages deployments with a `pages` concurrency group so a later push cannot race an in-flight deploy. Mirrors the docs workflow in decree-typescript. Refs #165 Co-Authored-By: Claude <noreply@anthropic.com>
zeevdr
added
size: S
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
Publishes the Python SDK docs to GitHub Pages, closing the last gap where Python
was the only SDK without a live docs site (Go on pkg.go.dev, TypeScript and the
Admin UI already publish).
Root cause: the
Deploy Docsworkflow built the site correctly, but every runfailed at the deploy step because GitHub Pages was never enabled on the
repository —
actions/deploy-pagesreturned404 ... Ensure GitHub Pages has been enabled. The mkdocs config,make docstarget, deploy workflow, and README linkswere all already in place; only the repo setting was missing.
Resolution:
build_type=workflow)via the Pages API.
Deploy Docsworkflow; build and deploy jobs are now green and thesite is live.
workflow_dispatchtrigger so thedocs can be redeployed manually, and a
pagesconcurrency group so overlappingdeploys are serialized — mirroring
decree-typescript.Test plan
Deploy Docsworkflow succeeds end-to-end (build + deploy jobs green)/,/guide/connect/,/guide/watch/,/guide/async/,/api/https://opendecree.github.io/decree-python)Closes #165