Skip to content

Commit c715f2d

Browse files
committed
Add RELEASING.md
1 parent 4d87153 commit c715f2d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

RELEASING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Releasing
2+
3+
1. Ensure that [`CHANGELOG.md`](./CHANGELOG.md) is up-to-date with all relevant changes. Additionally, make sure that the version specified in [Cargo.toml](./Cargo.toml) matches the to-be-released version.
4+
5+
1. Create and push a new Git tag for the version with a `v` prefix, e.g.:
6+
```shell
7+
git tag vX.Y.Z
8+
git push --tags
9+
```
10+
This will automatically run the "Publish release" GitHub Actions workflow, which will create a GitHub release, build a release tarball, and attach the tarball to the release.
11+
12+
1. Edit the newly created GitHub release, setting the relevant section of `CHANGELOG.md` as the description.

0 commit comments

Comments
 (0)