docs(contrib): Describe how to add a new package#12878
Merged
bors merged 1 commit intorust-lang:masterfrom Oct 25, 2023
Merged
Conversation
@Muscraft is considering adding a crate and we felt it was best to not just answer the question of how to do so but to document it!
Collaborator
|
r? @weihanglo (rustbot has picked a reviewer for you, use r? to override) |
weihanglo
reviewed
Oct 25, 2023
| - Add it to `.cargo/config.toml`s `[alias]` table | ||
| - Mark `package.publish = false` | ||
|
|
||
| If published, add the package to `publish.py`, in dependency order |
Member
There was a problem hiding this comment.
It's unclear whether a package is required to add to the list. Can we expand this a bit? Something like
Suggested change
| If published, add the package to `publish.py`, in dependency order | |
| If published, add the package to the [`TO_PUBLISH` list in `publish.py`](https://github.com/rust-lang/cargo/blob/9bf67a1026c023e2789e867d8b88dc6fc181f357/publish.py#L18-L28), in dependency order. | |
| Packages in `TO_PUBLISH` will be published automatically along with each new releases of Rust. | |
| Note that every package used by `cargo` the library is required to be available on crates.io, but not necessary to be in the `TO_PUBLISH` list. |
Contributor
Author
There was a problem hiding this comment.
I was wanting to hold off on getting into that level of detail to be more resilient against change. I have updated it. Is the new version sufficient?
ea592ba to
9a36c04
Compare
weihanglo
approved these changes
Oct 25, 2023
Member
weihanglo
left a comment
There was a problem hiding this comment.
I am pretty okay with this doc update 👍🏾.
Thank you.
Member
|
@bors r+ |
Contributor
Contributor
Contributor
|
☀️ Test successful - checks-actions |
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 28, 2023
Update cargo 8 commits in df3509237935f9418351b77803df7bc05c009b3d..708383d620e183a9ece69b8fe930c411d83dee27 2023-10-24 23:09:01 +0000 to 2023-10-27 21:09:26 +0000 - feat(doc): Print the generated docs links (rust-lang/cargo#12859) - feat(toml): Allow version-less manifests (rust-lang/cargo#12786) - Remove outdated option to `-Zcheck-cfg` warnings (rust-lang/cargo#12884) - Remove duplicate binaries during install (rust-lang/cargo#12868) - refactor(shell): Write at once rather than in fragments (rust-lang/cargo#12880) - docs(ref): Link to docs.rs metadata table (rust-lang/cargo#12879) - docs(contrib): Describe how to add a new package (rust-lang/cargo#12878) - move up looking at index summary enum (rust-lang/cargo#12749) r? ghost
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
5 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.
@Muscraft is considering adding a crate and we felt it was best to not just answer the question of how to do so but to document it!