add releasing documentation (#69)

capeprivacy · Dec 8, 2022 · 6a98a30 · 6a98a30
1 parent 8fb8c44
commit 6a98a30
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/RELEASING.md b/RELEASING.md
@@ -0,0 +1,19 @@
+# Releasing Nitrogen
+
+```
+cargo release <VERSION LEVEL> --execute --no-publish
+```
+
+Where `<VERSION LEVEL>` is one of `major`, `minor`, or `patch` depending on what version of nitrogen you want to release.
+
+Run the following to actually upload to cargo:
+
+```
+cargo publish
+```
+
+Afterwards we need to publish an alpha version to prepare for the next release.
+
+```
+cargo release alpha --execute --no-publish
+```