build: add crates.io package metadata - #14
Merged
Conversation
Both crates lacked the fields crates.io renders on a package page: cargo warned about the missing repository/homepage, and neither shipped a readme or the licence text. Add repository, homepage, keywords and categories, and link README.md and LICENSE into each crate directory so they land inside the published archive.
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.
What
Preparation for publishing to crates.io.
repository/homepageon the workspace, inherited by both crates —cargo warned that the manifests had none, and crates.io links them from the
package page.
keywordsandcategoriesper crate, so the packages are discoverable.README.mdandLICENSElinked into each crate directory. Cargo onlypackages files inside the crate, so without this the published archives
carried neither the licence text nor a rendered readme.
Verification
cargo package -p bugwarden-coreis now warning-free and the archivecontains
README.mdandLICENSE. The equivalent check forbugwardencannot pass until
bugwarden-coreis on the index — it resolves its pathdependency against crates.io during packaging — so that one is verified at
publish time, core first.
No code change; 129 tests unchanged.