meta: Add MAINTENANCE.md with release instructions (#217)

magic-wormhole · Jul 5, 2024 · 2fa0944 · 2fa0944
1 parent 379197a
commit 2fa0944
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/MAINTENANCE.md b/MAINTENANCE.md
@@ -0,0 +1,13 @@
+# Maintenance documentation
+
+## Release
+
+To create a new release, follow these steps:
+
+- Update version number in Cargo.toml for library and CLI
+- Update Cargo.lock
+- Commit the changes
+- Tag the commit: `git tag -as a.b.c`
+- Push the tag: `git push origin a.b.c`
+- Create a github release for the tag and upload the built binaries from the github actions workflow
+- Push a new crate version to crates.io with `cargo publish -p magic-wormhole`