[Chore] Generate release docs on zoo-stable-release dispatch - #64
Draft
zoomote[bot] wants to merge 1 commit into
Draft
zoomote[bot] wants to merge 1 commit into
zoomote[bot] wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
What changed
Adds the receiver side of the docs-release automation:
.github/workflows/zoo-stable-release.yml— triggers onrepository_dispatch(types: [zoo-stable-release]) sent by Zoo-Code after a stable publish. It validates the payload, runspnpm docs:release, then typecheck + lint + unused-import lint + full Docusaurus build, and — on success — commits the generated release docs tomainwith the same-repoGITHUB_TOKEN. The push tomainis what publishes to docs.zoocode.dev through the existing deployment pipeline. Concurrency is keyed on the release tag so duplicate dispatches queue instead of racing.scripts/docs-release.mjs(newpnpm docs:releasescript) — a deterministic, dependency-free generator that:docs/update-notes/vX.Y.Z.mdxif missing (existing pages are never rewritten — human enrichment lands in reviewed PRs),docs/update-notes/index.mdand the "Extension Release Notes" category insidebars.ts, newest-first (single-line sidebar categories are normalized to multi-line first),package.jsonversionto the extension version, never downgrading,Why this change was made
Publishing a stable extension currently requires manual release-notes bookkeeping in this repo. The Zoo-Code publisher now dispatches
version,tag,source_sha,release_url(and the extracted changelog section aschanges) so the mechanical parts happen automatically and consistently.Impact
No change to existing docs content or site behavior today; the new workflow only runs on the dispatch event. Evergreen docs and enriched prose are intentionally not auto-rewritten — the automation is limited to the deterministic release-notes/index/version updates, and the generated notes page carries a comment directing enrichment edits to reviewed PRs. If branch protection blocks direct pushes to
main, the final workflow step should be switched to an auto-merge PR flow (noted in a workflow comment).Validation:
pnpm run check-types,pnpm run lint,pnpm run lint:unused, andpnpm run buildall pass. The generator was dry-run end-to-end against a scratch copy of this repo (new minor, patch into existing category, older-minor insertion, no-downgrade, idempotent re-run) with the resulting site passingtsc --noEmitand a full Docusaurus build; both workflow files passactionlint.Related PRs