decree-docs: scaffold contrib module and CI wiring#928
Merged
Conversation
Create the contrib/decree-docs Go module on the 1.24 tier: a cobra-based skeleton for the standalone multi-format schema documentation generator, with a version subcommand, in-process CLI tests, and a smoke test that builds the binary and runs --help and version. Wire the module into the Makefile module loops, the CI per-module test, ratchet, and coverage-merge steps, the check-coverage.sh module arrays (floor 88.8%), and the dependabot go 1.24 tier. Add contrib/README.md documenting the contrib/ (standalone tools) vs sdk/contrib/ (SDK framework adapters) split, and refresh the stale module-inventory lines in CONTRIBUTING.md and docs/sdk.md. Closes #913 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
zeevdr
added
size: M
Codecov Report❌ Patch coverage is
📢 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
contrib/decree-docsmodule so the full-featured docs generator can grow without weighing down the zero-dependencysdk/tools/docgencore.versionsubcommand with the same ldflags mechanism ascmd/decree, and a testablerun()seam; loaders and output formats arrive in decree-docs: doc model, schema loaders, and JSON output #914–decree-docs: documentation, example outputs, freshness CI #920.contrib/README.md: top-levelcontrib/hosts standalone tools,sdk/contrib/hosts SDK framework adapters; stale module-inventory lines in CONTRIBUTING.md and docs/sdk.md fixed to match.Test plan
make test— all modules pass, including the new one./scripts/check-coverage.sh— contrib/decree-docs 88.9% (≥88.8), all modules greenmake lint-goclean;gofumpt/go build/go vetclean in the new module--helpandversionexit 0Closes #913