You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1ea8674 [doc] update release-process.md and backports section of CONTRIBUTING (glozow)
Pull request description:
While doing various release process things for the first time, I noticed some of our docs are outdated and/or confusing.
ACKs for top commit:
achow101:
ACK 1ea8674
Tree-SHA512: 4ad10d4ce2c33fe15cb02599353107bb72ecb867aefc6c120cfd5cdea42aa8fa3783f9e0218c2f3815f030e0694cc8fb24011ce88358a0206cb07416a256a962
Copy file name to clipboardExpand all lines: doc/release-process.md
+42-41
Original file line number
Diff line number
Diff line change
@@ -5,17 +5,17 @@ Release Process
5
5
6
6
### Before every release candidate
7
7
8
-
* Update translations see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations).
9
8
* Update release candidate version in `configure.ac` (`CLIENT_VERSION_RC`).
10
9
* Update manpages (after rebuilding the binaries), see [gen-manpages.py](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-manpagespy).
11
-
* Update bitcoin.conf and commit, see [gen-bitcoin-conf.sh](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-bitcoin-confsh).
10
+
* Update bitcoin.conf and commit changes if they exist, see [gen-bitcoin-conf.sh](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-bitcoin-confsh).
12
11
13
12
### Before every major and minor release
14
13
15
14
* Update [bips.md](bips.md) to account for changes since the last release.
16
15
* Update version in `configure.ac` (don't forget to set `CLIENT_VERSION_RC` to `0`).
17
16
* Update manpages (see previous section)
18
-
* Write release notes (see "Write the release notes" below).
17
+
* Write release notes (see "Write the release notes" below) in doc/release-notes.md. If necessary,
18
+
archive the previous release notes as doc/release-notes/release-notes-${VERSION}.md.
19
19
20
20
### Before every major release
21
21
@@ -28,6 +28,7 @@ Release Process
28
28
29
29
#### Before branch-off
30
30
31
+
* Update translations see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations).
31
32
* Update hardcoded [seeds](/contrib/seeds/README.md), see [this pull request](https://github.com/bitcoin/bitcoin/pull/27488) for an example.
32
33
* Update the following variables in [`src/kernel/chainparams.cpp`](/src/kernel/chainparams.cpp) for mainnet, testnet, and signet:
33
34
-`m_assumed_blockchain_size` and `m_assumed_chain_state_size` with the current size plus some overhead (see
@@ -161,32 +162,40 @@ Then open a Pull Request to the [guix.sigs repository](https://github.com/bitcoi
161
162
162
163
### macOS codesigner only: Create detached macOS signatures (assuming [signapple](https://github.com/achow101/signapple/) is installed and up to date with master branch)
163
164
165
+
In the `guix-build-${VERSION}/output/x86_64-apple-darwin` and `guix-build-${VERSION}/output/arm64-apple-darwin` directories:
166
+
164
167
tar xf bitcoin-osx-unsigned.tar.gz
165
168
./detached-sig-create.sh /path/to/codesign.p12
166
169
Enter the keychain password and authorize the signature
167
170
signature-osx.tar.gz will be created
168
171
169
172
### Windows codesigner only: Create detached Windows signatures
170
173
174
+
In the `guix-build-${VERSION}/output/x86_64-w64-mingw32` directory:
### Windows and macOS codesigners only: test code signatures
177
182
It is advised to test that the code signature attaches properly prior to tagging by performing the `guix-codesign` step.
178
-
However if this is done, once the release has been tagged in the bitcoin-detached-sigs repo, the `guix-codesign` step must be performed again in order for the guix attestation to be valid when compared against the attestations of non-codesigner builds.
183
+
However if this is done, once the release has been tagged in the bitcoin-detached-sigs repo, the `guix-codesign` step must be performed again in order for the guix attestation to be valid when compared against the attestations of non-codesigner builds. The directories created by `guix-codesign` will need to be cleared prior to running `guix-codesign` again.
179
184
180
185
### Windows and macOS codesigners only: Commit the detached codesign payloads
181
186
182
187
```sh
183
188
pushd ./bitcoin-detached-sigs
184
-
# checkout the appropriate branch for this release series
185
-
rm -rf ./*
189
+
# checkout or create the appropriate branch for this release series
190
+
git checkout --orphan <branch>
191
+
# if you are the macOS codesigner
192
+
rm -rf osx
186
193
tar xf signature-osx.tar.gz
194
+
# if you are the windows codesigner
195
+
rm -rf win
187
196
tar xf signature-win.tar.gz
188
197
git add -A
189
-
git commit -m "point to ${VERSION}"
198
+
git commit -m "<version>: {osx,win} signature for {rc,final}"
190
199
git tag -s "v${VERSION}" HEAD
191
200
git push the current branch and new tag
192
201
popd
@@ -216,45 +225,36 @@ popd
216
225
217
226
Then open a Pull Request to the [guix.sigs repository](https://github.com/bitcoin-core/guix.sigs).
218
227
219
-
## After 3 or more people have guix-built and their results match
228
+
## After 6 or more people have guix-built and their results match
220
229
221
-
Combine the `all.SHA256SUMS.asc` file from all signers into `SHA256SUMS.asc`:
230
+
After verifying signatures, combine the `all.SHA256SUMS.asc` file from all signers into `SHA256SUMS.asc`:
0 commit comments