chore(ci): add GitHub Pages workflow for Taskplane Overview microsite#584
Merged
Conversation
Deploys docs/taskplane-overview/ to GitHub Pages on every push to main that touches that folder (or this workflow). Uses the official actions/configure-pages + upload-pages-artifact + deploy-pages stack and the github-pages environment. Scope is intentionally narrow — only the Overview deck is served, not the rest of docs/. To broaden later, change the path on the upload step (or switch Pages source to a /docs branch deploy and delete this workflow). No other part of the repo references this folder. Requires a one-time settings change: repo Settings -> Pages -> Source must be set to 'GitHub Actions' before the first deploy succeeds.
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.
Adds
.github/workflows/pages.ymlto deploydocs/taskplane-overview/to GitHub Pages.Scope
Only the Overview deck is served — not the rest of
docs/. To broaden the site later, change thepath:value on theupload-pages-artifactstep. To switch to a/docs-wide branch deploy, change Settings → Pages source to 'Deploy from a branch' and delete this workflow.Workflow details
mainthat touchdocs/taskplane-overview/**or the workflow itself, plus manualworkflow_dispatch.contents:read,pages:write,id-token:write).group: pages,cancel-in-progress: false— in-flight deploys finish before the next one starts.github-pages(auto-created when Pages is enabled).actions/checkout@v4,actions/configure-pages@v5,actions/upload-pages-artifact@v3,actions/deploy-pages@v4(all official, pinned to current majors).One-time setup required
Before this workflow's first run will succeed, repo Settings → Pages → Source must be set to 'GitHub Actions'. That enables Pages on the repo and creates the
github-pagesenvironment that this workflow targets. Until that's done, the workflow will fail on theconfigure-pagesstep with a 404.Why no release
Adds infra/automation, no runtime/CLI/config/schema change.