aboutsummaryrefslogtreecommitdiff
path: root/doc/release-process.md
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@protonmail.com>2021-01-28 21:17:11 +0100
committerWladimir J. van der Laan <laanwj@protonmail.com>2021-01-29 08:46:11 +0100
commitcc30dfbd4bab5fe4acc82dca9f6979e5a3a41e32 (patch)
tree733ec99dd5c3947f10ca973a3166419a24b32036 /doc/release-process.md
parent6ba2ffd28b6bf15e3f70982ccd45256a657c5f70 (diff)
doc: Document use of make-tag script to make tags
To make release tags the `make-tag.py` script from the maintainer tools should be used. This ensures that all the various occurences of the version in different files match the tagged version before proceeding. Also replace other "ping wumpus" references.
Diffstat (limited to 'doc/release-process.md')
-rw-r--r--doc/release-process.md20
1 files changed, 9 insertions, 11 deletions
diff --git a/doc/release-process.md b/doc/release-process.md
index 9fdb19edf1..84b208a0d8 100644
--- a/doc/release-process.md
+++ b/doc/release-process.md
@@ -5,7 +5,7 @@ Release Process
### Before every release candidate
-* Update translations (ping wumpus on IRC) see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations).
+* Update translations see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations).
* Update manpages, see [gen-manpages.sh](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-manpagessh).
* Update release candidate version in `configure.ac` (`CLIENT_VERSION_RC`).
@@ -52,6 +52,13 @@ Release Process
- Merge the release notes from the wiki into the branch.
- Ensure the "Needs release note" label is removed from all relevant pull requests and issues.
+#### Tagging a release (candidate)
+
+To tag the version (or release candidate) in git, use the `make-tag.py` script from [bitcoin-maintainer-tools](https://github.com/bitcoin-core/bitcoin-maintainer-tools). From the root of the repository run:
+
+ ../bitcoin-maintainer-tools/make-tag.py v(new version, e.g. 0.20.0)
+
+This will perform a few last-minute consistency checks in the build system files, and if they pass, create a signed tag.
## Building
@@ -73,21 +80,12 @@ Open a draft of the release notes for collaborative editing at https://github.co
For the period during which the notes are being edited on the wiki, the version on the branch should be wiped and replaced with a link to the wiki which should be used for all announcements until `-final`.
-Write the release notes. `git shortlog` helps a lot, for example:
-
- git shortlog --no-merges v(current version, e.g. 0.19.2)..v(new version, e.g. 0.20.0)
-
-(or ping @wumpus on IRC, he has specific tooling to generate the list of merged pulls
-and sort them into categories based on labels).
+Generate the change log. As this is a huge amount of work to do manually, there is the `list-pulls` script to do a pre-sorting step based on github PR metadata. See the [documentation in the README.md](https://github.com/bitcoin-core/bitcoin-maintainer-tools/blob/master/README.md#list-pulls).
Generate list of authors:
git log --format='- %aN' v(current version, e.g. 0.20.0)..v(new version, e.g. 0.20.1) | sort -fiu
-Tag the version (or release candidate) in git:
-
- git tag -s v(new version, e.g. 0.20.0)
-
### Setup and perform Gitian builds
If you're using the automated script (found in [contrib/gitian-build.py](/contrib/gitian-build.py)), then at this point you should run it with the "--build" command. Otherwise ignore this.