diff --git a/RELEASE.md b/RELEASE.md index 6cb61d5..349ce6f 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -2,18 +2,10 @@ The releases are automated via [`release-plz`](https://github.com/MarcoIeni/release-plz), [`cargo-dist`](https://github.com/axodotdev/cargo-dist) and [GitHub Actions](https://docs.github.com/en/actions). -1. Run `release-plz release-pr` to create a pull request representing the new release. +1. `release-plz` creates a pull request for the new releases automatically. So simply merge the [release PR](https://release-plz.ieni.dev/docs/usage/release-pr) for updating the crate versions and changelog. See [#28](https://github.com/orhun/daktilo/pull/28) for an example. - - Use `release-plz update` to see the changes locally if needed. +2. After the merge, `release-plz` will pick up the new version and automatically create a tag. This will trigger `cargo-dist` and release binaries will be built in via [release workflow](.github/workflows/release.yml). -2. After merging the release PR, `git pull` your changes and run `release-plz release`. +3. Mark the package out-of-date for package managers. - - This will create a tag and update the [crates.io](https://crates.io/crates/daktilo) release. - -3. Run `git push --tags` the tag. - - - This will trigger `cargo-dist` and release binaries will be built in via [release workflow](.github/workflows/release.yml). - -4. Mark the package out-of-date for package managers. - -5. Announce the release on social platforms. 🥳 +4. Announce the release on social platforms. 🥳