Make one_collect publish-ready for crates.io#290
Merged
Conversation
Add the metadata crates.io needs and a crate landing page:
- Add keywords, categories, homepage, documentation, and readme fields
to Cargo.toml.
- Add a crate-level README.md and surface it as the docs.rs landing
page via #![doc = include_str!("../README.md")].
- Exclude the UnitTest.pprof test artifact and the stack_gen C helper
from the published package.
Validated with cargo publish --dry-run.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
brianrob
force-pushed
the
brianrob/crate-prep
branch
from
8aa1a72 to
9a9ecce
Compare
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
2 participants
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
Adds the metadata crates.io needs to publish
one_collect, a crate-level READMEthat doubles as the docs.rs landing page, and a crate-local license file.
What changed
keywords,categories,homepage,documentation, andreadmefields to
Cargo.toml.README.mdand surface it as the docs.rs landing page via#![doc = include_str!("../README.md")].LICENSE(copy of the repo-root MIT license) so it isincluded in the published
.crate(cargo only packages files under the cratedirectory).
excludetheUnitTest.pproftest artifact and thestack_genC helper fromthe published package.
rustdocwarning inprocfs.rs(/proc/[pid]was parsed as anintra-doc link) so the docs.rs build is warning-free.
Notes
0.0.0-dev; the official release pipelinereplaces it with a real version at publish time.