docs(postguard-dotnet): document the pg-ffi pin, testing and the tracked public API surface - #128
Draft
dobby-coder[bot] wants to merge 1 commit into
Draft
docs(postguard-dotnet): document the pg-ffi pin, testing and the tracked public API surface#128dobby-coder[bot] wants to merge 1 commit into
dobby-coder[bot] wants to merge 1 commit into
Conversation
…ked public API surface Landed from postguard-dotnet's CLAUDE.md, which encryption4all/dobby-code#696 cuts back to orientation. This is the half of that file that was documentation rather than a durable check: how the pinned pg-ffi release is consumed, how to run the tests across both target frameworks, and how PublicApiAnalyzers gates the public surface. Refs: encryption4all/dobby-code#696
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.
Adds three things to
docs/repos/postguard-dotnet.mdthat were only written down in that repo'sCLAUDE.md.Why now
encryption4all/dobby-code#696 cuts
postguard-dotnet'sCLAUDE.mdback to orientation: what the repo is, where it sits, which siblings a change touches. The rest of that file splits into detail that is documentation and detail that is a durable check. Point 7 of the cross-repo picture in dobby-code#675 says where the documentation half goes:This is that half. The cut itself is encryption4all/postguard-dotnet#55, and this PR should land first: the cut file forwards readers here for the tracked public API surface, and the page carries nothing about it until this merges.
What is added
The pinned
pg-ffirelease. The page said CI downloads native libraries "from the postguard releases" without saying which. It downloads the release named in.github/pg-ffi-version, a one-line file both workflows feed togh release download. Worth stating: an agent that reads the vague version reaches for a "newest release" lookup, which changes what ships without a commit.Testing. A
dotnet testinvocation, and the note that the solution multi-targetsnet8.0andnet10.0, so a plain run needs both runtimes.Public API surface. The largest piece:
src/PublicAPI.Shipped.txtandsrc/PublicAPI.Unshipped.txt, checked by PublicApiAnalyzers duringdotnet buildwith no separate CI step. How to add a member, how to record a removal, why severity is in the.csprojand not.editorconfig, and what has to happen at release time that release-please does not do.Style
Written to this repo's
CLAUDE.mdrules: prose rather than lists, zero em dashes, no bold in running prose, none of the banned vocabulary. All content is from the source repo at40004d5, not invented.npm run docs:buildpasses.Noticed, not fixed
"Run the example" on this page still links to
postguard-examples, which is archived.postguard-dotnet's README was corrected in postguard-dotnet#54 to point atpostguard-js/examples/pg-dotnetinstead. Left alone here to keep this PR to one concern, but it is a real dead link and worth its own small PR.