[tor-commits] [sbws/master] fix: scripts: Clarify the scope of the script

[juga at torproject.org]

commit 11c8cb66cf683512522899b8298929f3929b2a94
Author: juga0 <juga at riseup.net>
Date:   Fri Jul 17 12:50:49 2020 +0000

    fix: scripts: Clarify the scope of the script
    
    it should not take more effort than solving self-sbws issues.
---
 scripts/maint/release.py | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/scripts/maint/release.py b/scripts/maint/release.py
index 0c69f86..b5fdf3e 100755
--- a/scripts/maint/release.py
+++ b/scripts/maint/release.py
@@ -4,7 +4,14 @@
 
 usage: release.py GPG_KEY_IDENTIFIER
 
-It will:
+This is a fast and dirty script to help release new sbws versions.
+It does not intent to cover all possible cases and errors because this is out
+of the scope of sbws.
+There are other tools [*] that help manage release tags, branches and
+changelogs, but we should not add more requirements to sbws to just release a
+new version.
+
+This script will:
 0. Detect the current program version
 1. Ask which version to release
 2. Update the changelog automatically with ``gitchangelog``
@@ -17,7 +24,7 @@ It will:
 8. Modify the program to the next prerelease version and commit it
 9. Push the commit
 
-All in sequence and doesn't recover from any previous step.
+All is done in sequence and doesn't recover from any previous step.
 
 It assumes that:
 - the program version can be obtained with ``sbws.__version__``
@@ -25,6 +32,9 @@ It assumes that:
 - the official tarball releases are at gitlab.torproject.org
 - the key to sign the release is only one and is available in the system
 
+[*] See for instance https://semantic-release.gitbook.io,
+    https://github.com/GitTools/GitVersion
+
 """
 import re
 import subprocess