From 18ddfeb2eb93dccbfd2126d2fe9bd33b31d54e31 Mon Sep 17 00:00:00 2001 From: Fina Wilke Date: Sun, 25 Feb 2024 17:10:43 +0100 Subject: [PATCH] contributing: Add MAINTENANCE.md with release instructions --- MAINTENANCE.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 MAINTENANCE.md diff --git a/MAINTENANCE.md b/MAINTENANCE.md new file mode 100644 index 00000000..d73c9dfd --- /dev/null +++ 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`