Skip to content

Commit 56fcf93

Browse files
committed
Merge bitcoin#21026: doc: Document use of make-tag script to make tags
cc30dfb doc: Document use of make-tag script to make tags (Wladimir J. van der Laan) Pull request description: To make release tags the `make-tag.py` script from the maintainer tools should be used. This ensures that all the various occurrences of the version in different files match the tagged version before proceeding. And move it into a separate section with the other per-release actions. Also replace other "ping wumpus" references. ACKs for top commit: jonatack: ACK cc30dfb Tree-SHA512: c09748a0bea85573b3f04fdb86430a53b683ff4d956edc1f49d471e2e526715cbde7cf6ad83a43a1a3fca4ff3c5af011e3d1b8cb61f5d8e065cfa71ba0138c88
2 parents d0d2565 + cc30dfb commit 56fcf93

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

doc/release-process.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Release Process
55

66
### Before every release candidate
77

8-
* Update translations (ping wumpus on IRC) see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations).
8+
* Update translations see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations).
99
* Update manpages, see [gen-manpages.sh](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-manpagessh).
1010
* Update release candidate version in `configure.ac` (`CLIENT_VERSION_RC`).
1111

@@ -52,6 +52,13 @@ Release Process
5252
- Merge the release notes from the wiki into the branch.
5353
- Ensure the "Needs release note" label is removed from all relevant pull requests and issues.
5454

55+
#### Tagging a release (candidate)
56+
57+
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:
58+
59+
../bitcoin-maintainer-tools/make-tag.py v(new version, e.g. 0.20.0)
60+
61+
This will perform a few last-minute consistency checks in the build system files, and if they pass, create a signed tag.
5562

5663
## Building
5764

@@ -73,21 +80,12 @@ Open a draft of the release notes for collaborative editing at https://github.co
7380

7481
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`.
7582

76-
Write the release notes. `git shortlog` helps a lot, for example:
77-
78-
git shortlog --no-merges v(current version, e.g. 0.19.2)..v(new version, e.g. 0.20.0)
79-
80-
(or ping @wumpus on IRC, he has specific tooling to generate the list of merged pulls
81-
and sort them into categories based on labels).
83+
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).
8284

8385
Generate list of authors:
8486

8587
git log --format='- %aN' v(current version, e.g. 0.20.0)..v(new version, e.g. 0.20.1) | sort -fiu
8688

87-
Tag the version (or release candidate) in git:
88-
89-
git tag -s v(new version, e.g. 0.20.0)
90-
9189
### Setup and perform Gitian builds
9290

9391
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.

0 commit comments

Comments
 (0)