fix(packaging): include README on published aube crate#349
Merged
Conversation
The aube binary crate's `include` whitelist limited the package tarball to .rs files, and the workspace had no `readme` field, so crates.io had no README to render. Set `readme = "README.md"` at the workspace level and inherit it on the aube crate; cargo auto-bundles the README into the tarball regardless of the include list. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Greptile SummaryAdds Confidence Score: 5/5Safe to merge — purely additive metadata change with no code or logic impact. All changes are Cargo manifest metadata additions. No logic, no security surface, no breaking changes. Cargo's workspace inheritance correctly resolves the README path relative to the workspace root when packaging individual crates, so the No files require special attention. Important Files Changed
Reviews (2): Last reviewed commit: "fix(packaging): inherit readme on every ..." | Re-trigger Greptile |
Extends the previous commit so all 10 sibling library crates also publish with the project README on crates.io, not just the aube binary. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
readme = \"README.md\"to[workspace.package]and inherit it on the aube binary crate so crates.io renders the project README. Currently the crates.io page has no README because the binary crate'sincludewhitelist ([\"src/**/*.rs\", \"build.rs\"]) excluded it and noreadmefield was set.readmeis set, regardless ofinclude; verified withcargo package --list -p aube(README.md now appears in the file list).Test plan
cargo package --list -p aube --no-verifyshowsREADME.mdin the tarball🤖 Generated with Claude Code
Note
Low Risk
Low risk: this only adjusts Cargo package metadata for publishing and should not affect runtime behavior or dependencies.
Overview
Ensures crates published from this workspace include and render the repository
README.mdby settingreadme = "README.md"in[workspace.package]and having each crate inherit it viareadme.workspace = true(including theaubebinary crate that previously whitelisted files viainclude).Reviewed by Cursor Bugbot for commit 3134282. Bugbot is set up for automated code reviews on this repo. Configure here.