ci: add docs-dispatch workflow (composer pings) - #2
Closed
makegov-hal[bot] wants to merge 6 commits into
Closed
Conversation
Go SDK for the Tango API — federal contracts, IDVs, entities, opportunities, grants, vehicles, and more, with dynamic response shaping. Ships the full transport, error model, retry/rate-limit handling, webhook signing+CRUD, and a curated subset of resource methods. The sibling SDKs (tango-node, tango-python) are at v1.0.0; this Go SDK starts at v0.1.0 and will grow toward parity in the 0.x line. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
golangci-lint v1.64.8 was choking on Go 1.26 stdlib build-tagged files (chacha20poly1305/fips140only_go1.26.go), cascading into bogus "undefined: tango" typecheck errors against examples/. Linting against the declared minimum Go version (1.23) is also the more conventional choice for OSS — lint what you support. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Pure whitespace — no semantic changes. Caught by the lint job once it got past the Go 1.26 stdlib typecheck cascade. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
- transport.go: defer the standard idiom that errcheck complains about by explicitly discarding the Close error. - testutil_test.go: remove three unused helpers (newTestClientFull, singleResultHandler, singleRecordHandler) and the now-unused net/http/httptest + time imports. The remaining helpers are all in use. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Mirrors the pattern in makegov/docs. Runs fast checks (gofmt, go vet,
end-of-file, trailing-whitespace) on commit, and golangci-lint on push
so contributors catch lint failures locally before CI does.
Local setup:
brew install pre-commit # or: pip install pre-commit
make hooks
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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>
infinityplusone
force-pushed
the
ci/docs-dispatch
branch
from
May 15, 2026 18:53
21e1f6b to
ae94638
Compare
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
.github/workflows/docs-dispatch.yml— on push tomain, pingsmakegov/docsviarepository_dispatchwhendocs/,README.md, orCHANGELOG.mdchanges.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)
contents:writeonmakegov/docs.DOCS_DISPATCH_TOKENonmakegov/tango-go.DOCS_TARGET_REPOif dispatching anywhere other thanmakegov/docs.Testing
docs/CLIENT.md(or any tracked doc file), push tomain, confirm the dispatch fires in Actions logs.makegov/docssees theexternal_updatedevent and rebuilds.Risks
DOCS_DISPATCH_TOKENisn'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.