Skip to content

Commit b6c66f3

Browse files
committed
Merge bitcoin/bitcoin#28003: doc: cleanup release process doc
bd5ae6c doc: misc changes in release-process (fanquake) d99ba3c doc: filter out merge-script from list of authors (josibake) 472d6f7 doc: remove generate changelog section from release-process.md (fanquake) 5555ecb doc: remove note to update bips.md version number (fanquake) Pull request description: Collection of changes to to simplify / correct the release-process documentation. I think we could still simplify this further. For example, we could remove the guix building docs, and defer to `contrib/guix`. ACKs for top commit: MarcoFalke: lgtm ACK bd5ae6c Tree-SHA512: 44bd12dd4f09380daee03fa79f01f9f7e8e2d5cc2fd5ff8c9e85ab54b4ea2b8a35df30ce3bdecfb4ff056cf52822be771ed3419613f68929c122750b1f8c89f9
2 parents 8535802 + bd5ae6c commit b6c66f3

File tree

1 file changed

+10
-20
lines changed

1 file changed

+10
-20
lines changed

doc/release-process.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Release Process
1212

1313
### Before every major and minor release
1414

15-
* Update [bips.md](bips.md) to account for changes since the last release (don't forget to bump the version number on the first line).
15+
* Update [bips.md](bips.md) to account for changes since the last release.
1616
* Update version in `configure.ac` (don't forget to set `CLIENT_VERSION_RC` to `0`).
1717
* Update manpages (see previous section)
1818
* Write release notes (see "Write the release notes" below).
@@ -57,7 +57,7 @@ Release Process
5757
- Update the versions.
5858
- Create the draft, named "*version* Release Notes Draft", as a [collaborative wiki](https://github.com/bitcoin-core/bitcoin-devwiki/wiki/_new).
5959
- Clear the release notes: `cp doc/release-notes-empty-template.md doc/release-notes.md`
60-
- Create a pinned meta-issue for testing the release candidate (see [this issue](https://github.com/bitcoin/bitcoin/issues/17079) for an example) and provide a link to it in the release announcements where useful.
60+
- Create a pinned meta-issue for testing the release candidate (see [this issue](https://github.com/bitcoin/bitcoin/issues/27621) for an example) and provide a link to it in the release announcements where useful.
6161
- Translations on Transifex
6262
- Change the auto-update URL for the new major version's resource away from `master` and to the branch, e.g. `https://raw.githubusercontent.com/bitcoin/bitcoin/<branch>/src/qt/locale/bitcoin_en.xlf`. Do not forget this or it will keep tracking the translations on master instead, drifting away from the specific major release.
6363
- Prune inputs from the qa-assets repo (See [pruning
@@ -72,7 +72,7 @@ Release Process
7272

7373
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:
7474

75-
../bitcoin-maintainer-tools/make-tag.py v(new version, e.g. 23.0)
75+
../bitcoin-maintainer-tools/make-tag.py v(new version, e.g. 25.0)
7676

7777
This will perform a few last-minute consistency checks in the build system files, and if they pass, create a signed tag.
7878

@@ -96,11 +96,9 @@ Open a draft of the release notes for collaborative editing at https://github.co
9696

9797
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`.
9898

99-
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).
100-
10199
Generate list of authors:
102100

103-
git log --format='- %aN' v(current version, e.g. 24.0)..v(new version, e.g. 24.1) | sort -fiu
101+
git log --format='- %aN' v(current version, e.g. 25.0)..v(new version, e.g. 25.1) | grep -v 'merge-script' | sort -fiu
104102

105103
### Setup and perform Guix builds
106104

@@ -109,7 +107,7 @@ Checkout the Bitcoin Core version you'd like to build:
109107
```sh
110108
pushd ./bitcoin
111109
SIGNER='(your builder key, ie bluematt, sipa, etc)'
112-
VERSION='(new version without v-prefix, e.g. 24.0)'
110+
VERSION='(new version without v-prefix, e.g. 25.0)'
113111
git fetch origin "v${VERSION}"
114112
git checkout "v${VERSION}"
115113
popd
@@ -144,10 +142,11 @@ Follow the relevant Guix README.md sections:
144142
pushd ./guix.sigs
145143
git add "${VERSION}/${SIGNER}"/noncodesigned.SHA256SUMS{,.asc}
146144
git commit -m "Add attestations by ${SIGNER} for ${VERSION} non-codesigned"
147-
git push # Assuming you can push to the guix.sigs tree
148145
popd
149146
```
150147

148+
Then open a Pull Request to the [guix.sigs repository](https://github.com/bitcoin-core/guix.sigs).
149+
151150
## Codesigning
152151

153152
### macOS codesigner only: Create detached macOS signatures (assuming [signapple](https://github.com/achow101/signapple/) is installed and up to date with master branch)
@@ -202,10 +201,11 @@ popd
202201
pushd ./guix.sigs
203202
git add "${VERSION}/${SIGNER}"/all.SHA256SUMS{,.asc}
204203
git commit -m "Add attestations by ${SIGNER} for ${VERSION} codesigned"
205-
git push # Assuming you can push to the guix.sigs tree
206204
popd
207205
```
208206

207+
Then open a Pull Request to the [guix.sigs repository](https://github.com/bitcoin-core/guix.sigs).
208+
209209
## After 3 or more people have guix-built and their results match
210210

211211
Combine the `all.SHA256SUMS.asc` file from all signers into `SHA256SUMS.asc`:
@@ -268,17 +268,7 @@ cat "$VERSION"/*/all.SHA256SUMS.asc > SHA256SUMS.asc
268268

269269
- bitcoincore.org RPC documentation update
270270

271-
- Install [golang](https://golang.org/doc/install)
272-
273-
- Install the new Bitcoin Core release
274-
275-
- Run bitcoind on regtest
276-
277-
- Clone the [bitcoincore.org repository](https://github.com/bitcoin-core/bitcoincore.org)
278-
279-
- Run: `go run generate.go` while being in `contrib/doc-gen` folder, and with bitcoin-cli in PATH
280-
281-
- Add the generated files to git
271+
- See https://github.com/bitcoin-core/bitcoincore.org/blob/master/contrib/doc-gen/
282272

283273
- Update packaging repo
284274

0 commit comments

Comments
 (0)