GitLab is used only for code review, issue tracking and project management. Canonical locations for source code are still https://gitweb.torproject.org/ https://git.torproject.org/ and git-rw.torproject.org.

Commit 11c8cb66 authored by juga  's avatar juga 💬

fix: scripts: Clarify the scope of the script

it should not take more effort than solving self-sbws issues.
parent ef2e35a8
...@@ -4,7 +4,14 @@ ...@@ -4,7 +4,14 @@
usage: release.py GPG_KEY_IDENTIFIER 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 0. Detect the current program version
1. Ask which version to release 1. Ask which version to release
2. Update the changelog automatically with ``gitchangelog`` 2. Update the changelog automatically with ``gitchangelog``
...@@ -17,7 +24,7 @@ It will: ...@@ -17,7 +24,7 @@ It will:
8. Modify the program to the next prerelease version and commit it 8. Modify the program to the next prerelease version and commit it
9. Push the commit 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: It assumes that:
- the program version can be obtained with ``sbws.__version__`` - the program version can be obtained with ``sbws.__version__``
...@@ -25,6 +32,9 @@ It assumes that: ...@@ -25,6 +32,9 @@ It assumes that:
- the official tarball releases are at gitlab.torproject.org - the official tarball releases are at gitlab.torproject.org
- the key to sign the release is only one and is available in the system - 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 re
import subprocess import subprocess
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment