From 442a7d18a5f721ff1de5e863739e6d725d13e75b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Filipe=20La=C3=ADns?= <lains@archlinux.org>
Date: Mon, 16 Mar 2020 21:13:01 +0000
Subject: [PATCH] release.sh: document release process
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Filipe Laíns <lains@archlinux.org>
---
 RELEASE.md | 14 ++++++++++++++
 release.sh |  3 ++-
 2 files changed, 16 insertions(+), 1 deletion(-)
 create mode 100644 RELEASE.md

diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 00000000..7c17a170
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,14 @@
+# Solaar releases
+
+###### Please read before making a release.
+
+We support two type of releases: normal releases (ex. `1.0.0`) and release
+candidates (ex. `1.0.0-rc1`). Release candidates must have a `-rcX` prefix.
+
+Release routine:
+  - Update the ChangeLog and setup.py to the new version and create a commit
+    - Release commits must start with `release VERSION`
+  - Invoke `./release.sh`
+    - Git tags are signed so you must have GPG set up
+    - You are required to have a have a github token with `public_repo` access
+      in `~/.github-token`
diff --git a/release.sh b/release.sh
index 4d52ef25..d5cc78dd 100755
--- a/release.sh
+++ b/release.sh
@@ -74,7 +74,8 @@ else
     echo "Local branch: $branch"
     echo "Remote branch: $remote_branch"
 fi
-echo
+
+echo -e '\nPlease read RELEASE.md before continuing.\n'
 
 read -p 'Are you sure you want to proceed? (y/n) ' -n 1 -r < /dev/tty
 echo