Repository navigation
ci: check the README's C# blocks against the package - #18
Merged
Merged
Conversation
A reader who copies a C# block out of the README gets code that compiles against this package, and a block that stops compiling fails CI before it ships. The job calls the shared check pinned by full commit SHA; a doc change runs it, since neither workflow has a paths-ignore. The release waits on it: release.yml runs the same check at the tag and the publish job needs it, so the package about to reach NuGet is the one the blocks were compiled against. Refs macula-codebase-checks#8
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.
Purpose (usability): a reader who copies a C# block out of this package's README gets code that compiles against the package, and a block that stops compiling fails CI before it ships (macula-io/macula-codebase-checks#8).
ci.yml: adocsjob callingmacula-io/macula-ci-images/.github/workflows/doc-snippets-csharp.ymlpinned by full commit SHA (d25a36c). The workflow has nopaths-ignore, so a doc-only change runs it.release.yml: the same check at the tag, andpublishhasneeds: [release-guard, docs], so the package that reaches NuGet is the one the blocks were compiled against.The check builds the package, wraps each README block in a fragment or a file, and maps every compiler error back to the doc line. Locally it reports 0 failures in 4 blocks, and it ran green on the same commit's first draft PR (#17), which this rebase replaces.
Refs macula-io/macula-codebase-checks#8
🤖 Generated with Claude Code