This repository has been archived by the owner on Sep 10, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update release docs and tweak the scripts a bit
- Loading branch information
Showing
4 changed files
with
24 additions
and
4 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,22 @@ | ||
# Releasing this crate | ||
|
||
## Prerequisites | ||
|
||
* Ensure you have a GPG keypair created that you can use to sign the | ||
release tag. | ||
* Install `toml` with `cargo install toml`. | ||
|
||
## Releasing | ||
|
||
1. Run `./prepare-release.sh NEW_VERSION` (substituting the new desired | ||
version for `NEW_VERSION`). | ||
2. Go to the GitHub releases page for this repo. There should be a | ||
draft release waiting. Edit it, set the title to the new version, | ||
and point it to the new tag that was just pushed. | ||
3. Once the release is created, GitHub Actions will build the new | ||
release and publish it to crates.io. | ||
point it to the new tag that was just pushed, and scan through the | ||
release notes to ensure they seem sane. When you click the Publish | ||
button, GitHub Actions will build the new release and publish it to | ||
crates.io. | ||
|
||
## TODO | ||
|
||
* Use the GH API to do step #2 above. |
This file contains 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