From 1a70c6e1fedf4c32b800264f63c50517d3380db3 Mon Sep 17 00:00:00 2001
From: Max Countryman <maxc@me.com>
Date: Fri, 31 Jul 2020 09:18:34 -0700
Subject: [PATCH] document initial release process

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

diff --git a/docs/releasing.md b/docs/releasing.md
new file mode 100644
index 00000000..ae7d8505
--- /dev/null
+++ b/docs/releasing.md
@@ -0,0 +1,32 @@
+# Releasing
+
+Releasing, i.e. crate publishing, has been automated via GitHub Actions.
+
+In order to author a new release, you simply tag the desired revision and push
+the resulting tag.
+
+**Before releasing** ensure `CHANGELOG.md` is updated appropriately as well as
+`Cargo.toml`.
+
+## Process
+
+Please ensure you follow the correct format when creating new tags. For
+instance:
+
+```
+git tag -a '0.6.0' -m '(cargo-release) sqlparser version 0.6.0'
+```
+
+This will create a new tag, `0.6.0` which the message,
+`(cargo-release) sqlparser version 0.6.0`.
+
+Once the tag is created, pushing the tag upstream will trigger a publishing
+process to crates.io. Now to push our example tag:
+
+```
+git push origin 0.6.0
+```
+
+(Note that this process is fully automated; credentials
+for authoring in this way are securely stored in the repo secrets as
+`CRATE_TOKEN`.)