Skip to content

Commit

Permalink
Document that we use release-plz
Browse files Browse the repository at this point in the history
The existing release docs haven't been updated since the process change.
Update contributing guidelines to reflect that we use release-plz.
  • Loading branch information
tgross35 committed Nov 7, 2024
1 parent 5dbbb6d commit c9ecb38
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,17 +89,8 @@ support anytime.

## Releasing your change to crates.io

Now that you've done the amazing job of landing your new API or your new
platform in this crate, the next step is to get that sweet, sweet usage from
crates.io! The only next step is to bump the version of libc and then publish
it. If you'd like to get a release out ASAP you can follow these steps:

1. Increment the patch version number in `Cargo.toml` and
`libc-test/Cargo.toml`.
1. Send a PR to this repository. It should [look like this][example-pr], but
it would also be nice to fill out the description with a small rationale for
the release (any rationale is ok though!).
1. Once merged, the release will be tagged and published by one of the libc
crate maintainers.

[example-pr]: https://github.com/rust-lang/libc/pull/2120
This repository uses [release-plz] to handle releases. Once your pull request
has been merged, a maintainer just needs to verify the generated changelog, then
merge the bot's release PR. This will automatically publish to crates.io!

[release-plz]: https://github.com/MarcoIeni/release-plz

0 comments on commit c9ecb38

Please sign in to comment.