chore(publish): apply per-crate readme override on all 6 publishable crates#381
Merged
Conversation
…crates Closes #240. All 6 publishable crates (uffs-time, uffs-text, uffs-mft, uffs-client, uffs-mcp, uffs-cli) ship their own README.md (#237 + #239) but still inherited readme.workspace = true, which resolves to the workspace-root app README via ../../README.md. cargo flagged every cargo package with: warning: readme '../../README.md' appears to be a path outside of the package, but there is already a file named README.md in the root ... Fix: flip each of the 6 manifests to readme = README.md (the crate's own file) and extend KnownExceptions::readme_override_ok from 2 to all 6 entries so manifest-audit invariant 3.5 permits the override. The suppression test now iterates the whole 6-crate subset to catch a future regression that drops one. Verification: cargo test -p uffs-manifest-audit -> 24 passed cargo run -p uffs-manifest-audit -> zero findings cargo package -p <each of 6> --list -> no readme warning, README.md archived
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.
Closes #240.
Problem
All 6 publishable crates ship their own
README.md(#237 + #239) but still inheritedreadme.workspace = true, which resolves to the workspace-root app README via../../README.md. Everycargo packageemitted:Fix
uffs-time,uffs-text,uffs-mft,uffs-client,uffs-mcp,uffs-cli) toreadme = "README.md"with a rationale comment.KnownExceptions::readme_override_okfrom 2 to all 6 entries so manifest-audit invariant 3.5 permits the override.Verification
cargo test -p uffs-manifest-audit: ✅ 24 passedcargo run -p uffs-manifest-audit: ✅ zero findingscargo package -p <each of 6> --list: ✅ no readme warning,README.mdstill archivedNote on #241
While investigating, confirmed #241's actionable parts are already done: keywords/categories overrides applied (uffs-time/text/client/mcp) and
doc_auto_cfgpresent in all 5 lib.rs files. The remainder of #241 is deliberately publish-day-deferred.