Skip to content

ci: add docs-dispatch workflow (composer pings)#4

Open
makegov-hal[bot] wants to merge 1 commit into
mainfrom
ci/docs-dispatch
Open

ci: add docs-dispatch workflow (composer pings)#4
makegov-hal[bot] wants to merge 1 commit into
mainfrom
ci/docs-dispatch

Conversation

@makegov-hal
Copy link
Copy Markdown

@makegov-hal makegov-hal Bot commented May 15, 2026

Summary

  • Adds .github/workflows/docs-dispatch.yml — on push to main, pings makegov/docs via repository_dispatch when docs/, README.md, or CHANGELOG.md changes.
  • Keeps the public docs site in sync without anyone needing to push to the composer manually.

Why a separate PR

This is the editorial-split / composer wiring. Splitting it from the initial commit so it's easy to see, easy to revert if we ever change the docs flow, and consistent with how the sibling SDKs (tango-node, tango-python) ship the same workflow today.

Setup checklist (do before merging)

  • Create a fine-grained PAT or app token with contents:write on makegov/docs.
  • Save it as repo secret DOCS_DISPATCH_TOKEN on makegov/tango-go.
  • (Optional) Set repo variable DOCS_TARGET_REPO if dispatching anywhere other than makegov/docs.

Testing

  • After merge, touch docs/CLIENT.md (or any tracked doc file), push to main, confirm the dispatch fires in Actions logs.
  • Confirm makegov/docs sees the external_updated event and rebuilds.

Risks

  • If DOCS_DISPATCH_TOKEN isn't set, the dispatch step fails loudly — the workflow doesn't affect anything else. Worst case: docs site lags until someone pushes manually to the composer.

Pings makegov/docs (the editorial composer) via repository_dispatch
when docs/, README.md, or CHANGELOG.md changes on main. Keeps the
public docs site fresh without waiting for someone to push to the
composer manually.

Requires a DOCS_DISPATCH_TOKEN repo secret with contents:write on
makegov/docs.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant