-
Notifications
You must be signed in to change notification settings - Fork 124
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Want to make sure the release process is documented somewhere.
- Loading branch information
Showing
1 changed file
with
15 additions
and
0 deletions.
There are no files selected for viewing
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 |
---|---|---|
@@ -0,0 +1,15 @@ | ||
Release Process | ||
=============== | ||
|
||
Wayland-rs has a CI automation for releasing all the subcrates on crates.io when a release is | ||
tagged. After updating the changelogs and versions. | ||
|
||
* Create a branch for the release | ||
* `cargo release` (install with `cargo install cargo-release`) can be used to bump versions | ||
- For instance, `cargo release --no-publish --no-tag --no-push --execute patch` | ||
* Amend the commit to update the changelogs of any subcrates with changelog entries to have a release | ||
date. | ||
* Create a pull request with the release. Check that there are no warnings from `publish` CI job | ||
- Those will become hard errors when a release is tagged | ||
* Merge PR, and tag as `release-YYYY-MM-DD`, with the current date | ||
* When the tag is pushed, CI will run and release to crates.io |