From 309db80c2fd6009cc91bb16ecabcdf8e69f1ace6 Mon Sep 17 00:00:00 2001
From: James Andariese <james@strudelline.net>
Date: Wed, 1 Nov 2023 20:15:47 -0500
Subject: [PATCH] add release instructions

---
 RELEASING.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 RELEASING.md

diff --git a/RELEASING.md b/RELEASING.md
new file mode 100644
index 0000000..04c9520
--- /dev/null
+++ b/RELEASING.md
@@ -0,0 +1,32 @@
+# Releasing
+
+Releasing involves upgrading dependencies, bumping versions,
+tagging in git, and publishing to crates.io. 
+
+### Upgrading dependencies
+
+Using VS Code and [the crates extension](https://marketplace.visualstudio.com/items?itemName=serayuzgur.crates), upgrade any outdated dependencies.
+
+Commit this change to current release branch.
+
+### Release new version
+
+```
+cargo set-version --bump patch
+VERSION="$(tomlq -r .package.version Cargo.toml)"
+git add Cargo.toml Cargo.lock
+git commit -m "release $VERSION"
+git merge main
+git checkout main
+git merge dev
+git tag "$VERSION"
+git checkout dev
+cargo set-version --bump alpha
+NEW_VERSION="$(tomlq -r .package.version Cargo.toml)"
+git add Cargo.toml Cargo.lock
+git commit -m "a new version appears: $NEW_VERSION
+```
+
+### Publish to crates.io
+
+cargo publish
\ No newline at end of file