docs: readd release workflow

garritfra · Feb 9, 2022 · 25d1f28 · 25d1f28
1 parent 7a5fcfe
commit 25d1f28
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/releasing.md b/docs/releasing.md
@@ -0,0 +1,9 @@
+# Release Workflow
+
+1. Update version in `Cargo.toml`
+1. Add entry in `CHANGELOG.md`
+1. Commit change with semantic version number (e.g.: `v0.1.1`)
+1. Tag commit using `git tag -a <new release> -m "$(git shortlog <last release>..HEAD)"`
+1. Push the tag using `git push --tags`
+1. Publish package using `cargo publish`
+1. Create new GitHub Release