aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorfanquake <fanquake@gmail.com>2023-08-01 09:39:07 +0100
committerfanquake <fanquake@gmail.com>2023-08-01 09:40:07 +0100
commitb6c66f309137bf10bb8ca7ab3f60ee4ee7a81316 (patch)
treecbe49ee68284931b8e6aaf98fb28904ef39dd966 /doc
parent8535802f1d67f2da6c060d2fdb02d15129424ebf (diff)
parentbd5ae6c66317de39195ddb38cea3ca05bbd99275 (diff)
downloadbitcoin-b6c66f309137bf10bb8ca7ab3f60ee4ee7a81316.tar.xz
Merge bitcoin/bitcoin#28003: doc: cleanup release process doc
bd5ae6c66317de39195ddb38cea3ca05bbd99275 doc: misc changes in release-process (fanquake) d99ba3cc01360f3d251a1d55c73c501822f83c67 doc: filter out merge-script from list of authors (josibake) 472d6f79b9bf7a714c3672ee88e21483a9a46042 doc: remove generate changelog section from release-process.md (fanquake) 5555ecb80ecc1373bc78b3029d1ee33183a9cdc0 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 bd5ae6c66317de39195ddb38cea3ca05bbd99275 Tree-SHA512: 44bd12dd4f09380daee03fa79f01f9f7e8e2d5cc2fd5ff8c9e85ab54b4ea2b8a35df30ce3bdecfb4ff056cf52822be771ed3419613f68929c122750b1f8c89f9
Diffstat (limited to 'doc')
-rw-r--r--doc/release-process.md30
1 files changed, 10 insertions, 20 deletions
diff --git a/doc/release-process.md b/doc/release-process.md
index 930110922c..c7a8998b8b 100644
--- a/doc/release-process.md
+++ b/doc/release-process.md
@@ -12,7 +12,7 @@ Release Process
### Before every major and minor release
-* 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).
+* Update [bips.md](bips.md) to account for changes since the last release.
* Update version in `configure.ac` (don't forget to set `CLIENT_VERSION_RC` to `0`).
* Update manpages (see previous section)
* Write release notes (see "Write the release notes" below).
@@ -57,7 +57,7 @@ Release Process
- Update the versions.
- Create the draft, named "*version* Release Notes Draft", as a [collaborative wiki](https://github.com/bitcoin-core/bitcoin-devwiki/wiki/_new).
- Clear the release notes: `cp doc/release-notes-empty-template.md doc/release-notes.md`
-- 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.
+- 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.
- Translations on Transifex
- 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.
- Prune inputs from the qa-assets repo (See [pruning
@@ -72,7 +72,7 @@ Release Process
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. 23.0)
+ ../bitcoin-maintainer-tools/make-tag.py v(new version, e.g. 25.0)
This will perform a few last-minute consistency checks in the build system files, and if they pass, create a signed tag.
@@ -96,11 +96,9 @@ 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`.
-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. 24.0)..v(new version, e.g. 24.1) | sort -fiu
+ git log --format='- %aN' v(current version, e.g. 25.0)..v(new version, e.g. 25.1) | grep -v 'merge-script' | sort -fiu
### Setup and perform Guix builds
@@ -109,7 +107,7 @@ Checkout the Bitcoin Core version you'd like to build:
```sh
pushd ./bitcoin
SIGNER='(your builder key, ie bluematt, sipa, etc)'
-VERSION='(new version without v-prefix, e.g. 24.0)'
+VERSION='(new version without v-prefix, e.g. 25.0)'
git fetch origin "v${VERSION}"
git checkout "v${VERSION}"
popd
@@ -144,10 +142,11 @@ Follow the relevant Guix README.md sections:
pushd ./guix.sigs
git add "${VERSION}/${SIGNER}"/noncodesigned.SHA256SUMS{,.asc}
git commit -m "Add attestations by ${SIGNER} for ${VERSION} non-codesigned"
-git push # Assuming you can push to the guix.sigs tree
popd
```
+Then open a Pull Request to the [guix.sigs repository](https://github.com/bitcoin-core/guix.sigs).
+
## Codesigning
### 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
pushd ./guix.sigs
git add "${VERSION}/${SIGNER}"/all.SHA256SUMS{,.asc}
git commit -m "Add attestations by ${SIGNER} for ${VERSION} codesigned"
-git push # Assuming you can push to the guix.sigs tree
popd
```
+Then open a Pull Request to the [guix.sigs repository](https://github.com/bitcoin-core/guix.sigs).
+
## After 3 or more people have guix-built and their results match
Combine the `all.SHA256SUMS.asc` file from all signers into `SHA256SUMS.asc`:
@@ -268,17 +268,7 @@ cat "$VERSION"/*/all.SHA256SUMS.asc > SHA256SUMS.asc
- bitcoincore.org RPC documentation update
- - Install [golang](https://golang.org/doc/install)
-
- - Install the new Bitcoin Core release
-
- - Run bitcoind on regtest
-
- - Clone the [bitcoincore.org repository](https://github.com/bitcoin-core/bitcoincore.org)
-
- - Run: `go run generate.go` while being in `contrib/doc-gen` folder, and with bitcoin-cli in PATH
-
- - Add the generated files to git
+ - See https://github.com/bitcoin-core/bitcoincore.org/blob/master/contrib/doc-gen/
- Update packaging repo