diff --git a/RELEASING.md b/RELEASING.md index 090b0feb4..e436364f6 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -13,35 +13,36 @@ The procedure is as follows: 1. Switch to a release branch: - ```bash - git switch -c release-x.y.z -  ``` + ```bash + git switch -c release-x.y.z + ``` 2. Prepare the release. This will update the `README.md`, set the versions in the `CHANGELOG.md` file, and bump the version in the `Cargo.toml` file. -```bash -cargo xtask release prepare --execute minor|patch|rc -``` + ```bash + cargo xtask release prepare --execute minor|patch|rc + ``` 3. Double-check and edit the `CHANGELOG.md` and `README.md` if necessary. Once you are satisfied, push the branch and open a PR. -```bash -git push --set-upstream origin/release-x.y.z -``` + ```bash + git push --set-upstream origin/release-x.y.z + ``` 4. Pass the review and merge the branch as you would with any other branch. 5. Create tags for your new release, publish the release on crates.io and push the tags: -```bash -# Switch to main first. -git switch main -# Pull in the now-merged release commit(s). -git pull -# Create tags, publish the release on crates.io, and push the tags. -cargo xtask release publish --execute -``` -For more information on cargo-release: https://github.com/crate-ci/cargo-release + ```bash + # Switch to main first. + git switch main + # Pull in the now-merged release commit(s). + git pull + # Create tags, publish the release on crates.io, and push the tags. + cargo xtask release publish --execute + ``` + + For more information on cargo-release: https://github.com/crate-ci/cargo-release