Add comments describing what each of the release scripts do

6 files changed, 16 insertions, 1 deletions

diff --git a/desktop/scripts/release/1-prepare-release b/desktop/scripts/release/1-prepare-release
index 7881597f88..932dc26c63 100755
--- a/desktop/scripts/release/1-prepare-release
+++ b/desktop/scripts/release/1-prepare-release
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 # This script prepares for a release. Run it with the release version as the first argument and it
-# will update version numbers, commit and add a signed tag.
+# will update version numbers, update the changelog, and update copyright year.
 
 set -eu
 
diff --git a/desktop/scripts/release/2-push-release-tag b/desktop/scripts/release/2-push-release-tag
index 6a19cf4fbf..c21809a27b 100755
--- a/desktop/scripts/release/2-push-release-tag
+++ b/desktop/scripts/release/2-push-release-tag
@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
 
+# This script creates and pushes a signed release tag. This should be run after `1-prepare-release`.
+
 set -eu
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
diff --git a/desktop/scripts/release/3-verify-build b/desktop/scripts/release/3-verify-build
index c0d5a71b47..be8ebde50d 100755
--- a/desktop/scripts/release/3-verify-build
+++ b/desktop/scripts/release/3-verify-build
@@ -1,5 +1,9 @@
 #!/usr/bin/env bash
 
+# This script verifies the build produced by the buildserver. It helps the user verify the staging
+# repository versions and triggers a e2e run with a small subset of the tests to verify the build.
+# This should be be run after `2-push-release-tag` and after the build server has finished building.
+
 set -eu
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
diff --git a/desktop/scripts/release/4-make-release b/desktop/scripts/release/4-make-release
index cd4897d837..0f421e30b1 100755
--- a/desktop/scripts/release/4-make-release
+++ b/desktop/scripts/release/4-make-release
@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+# This script downloads the build artifacts along with the signatures, verifies the signatures and
+# creates a GitHub draft release. This should be run after `3-verify-build`.
+
 set -eu
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
diff --git a/scripts/utils/gh-ready-check b/scripts/utils/gh-ready-check
index 97c0ee6539..164b5de903 100755
--- a/scripts/utils/gh-ready-check
+++ b/scripts/utils/gh-ready-check
@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+# This script controls that the gh (GitHub CLI) command is installed and authenticated. This can be
+# called in the beginning of all scripts depending on gh.
+
 set -eu
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
diff --git a/scripts/utils/print-and-run b/scripts/utils/print-and-run
index ab5443ed2e..b323040f3c 100755
--- a/scripts/utils/print-and-run
+++ b/scripts/utils/print-and-run
@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+# This is a small utility script that can be sourced to provide a function that prints its arguments
+# and then calls them as a command, e.g. `print_and_run sleep 5`.
+
 function print_and_run {
     echo "+ $*"
     "$@"