Skip to content

Commit c8a7ef6

Browse files
fanquakeknst
authored andcommitted
Merge bitcoin#24594: doc: update release-process.md
ac45a43 doc: update release-process.md (gruve-p) Pull request description: ACKs for top commit: achow101: ACK ac45a43 Tree-SHA512: eb49310e5645fcab47c6a268221b688d0ae4ffb1cc6d66fc097da1feb61aa894fb00065c20cd2413b775b598f8c955d48240608107776e4f1016703d52a81212
1 parent d5daccc commit c8a7ef6

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

doc/release-process.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -83,32 +83,28 @@ against other `guix-attest` signatures.
8383
git -C ./guix.sigs pull
8484
```
8585

86-
### Create the macOS SDK tarball: (first time, or when SDK version changes)
86+
### Create the macOS SDK tarball (first time, or when SDK version changes)
8787

8888
_Note: this step can be skipped if [our CI](https://github.com/dashpay/dash/blob/master/ci/test/00_setup_env.sh#L64) still uses bitcoin's SDK package (see SDK_URL)_
8989

9090
Create the macOS SDK tarball, see the [macOS build
9191
instructions](build-osx.md#deterministic-macos-app-notes) for
9292
details.
9393

94-
### Build and attest to build outputs:
94+
### Build and attest to build outputs
9595

9696
Follow the relevant Guix README.md sections:
9797
- [Building](/contrib/guix/README.md#building)
9898
- [Attesting to build outputs](/contrib/guix/README.md#attesting-to-build-outputs)
9999

100100
_Note: we ship releases for only some supported HOSTs so consider providing limited `HOSTS` variable or run `./contrib/containers/guix/scripts/guix-start` instead of `./contrib/guix/guix-build` when building binaries for quicker builds that exclude the supported but not shipped HOSTs_
101101

102-
### Verify other builders' signatures to your own. (Optional)
102+
### Verify other builders' signatures to your own (optional)
103103

104-
Add other builders keys to your gpg keyring, and/or refresh keys: See `../dash/contrib/builder-keys/README.md`.
105-
106-
Follow the relevant Guix README.md sections:
104+
- [Add other builders keys to your gpg keyring, and/or refresh keys](/contrib/builder-keys/README.md)
107105
- [Verifying build output attestations](/contrib/guix/README.md#verifying-build-output-attestations)
108106

109-
### Next steps:
110-
111-
Commit your signature to `guix.sigs`:
107+
### Commit your non codesigned signature to guix.sigs
112108

113109
```sh
114110
pushd guix.sigs
@@ -118,24 +114,22 @@ git push # Assuming you can push to the guix.sigs tree
118114
popd
119115
```
120116

121-
Codesigner only: Create Windows/macOS detached signatures:
122-
- Only one person handles codesigning. Everyone else should skip to the next step.
123-
- Only once the Windows/macOS builds each have 3 matching signatures may they be signed with their respective release keys.
117+
## Codesigning
124118

125-
Codesigner only: Sign the macOS binary:
119+
### macOS codesigner only: Create detached macOS signatures (assuming [signapple](https://github.com/achow101/signapple/) is installed and up to date with master branch)
126120

127121
* Transfer `dashcore-osx-unsigned.tar.gz` to macOS for signing
128122
* Extract and sign:
129123

130124
```sh
131125
tar xf dashcore-osx-unsigned.tar.gz
132-
./detached-sig-create.sh -s "Key ID" -o runtime
126+
./detached-sig-create.sh /path/to/codesign.p12 -o runtime
133127
```
134128

135129
* Enter the keychain password and authorize the signature
136-
* Move `signature-osx.tar.gz` back to the guix-build host
130+
* `signature-osx.tar.gz` will be created
137131

138-
Codesigner only: Sign the windows binaries:
132+
### Windows codesigner only: Create detached Windows signatures
139133

140134
* Extract and sign:
141135

@@ -147,10 +141,11 @@ Codesigner only: Sign the windows binaries:
147141
* Enter the passphrase for the key when prompted
148142
* `signature-win.tar.gz` will be created
149143

150-
Code-signer only: It is advised to test that the code signature attaches properly prior to tagging by performing the `guix-codesign` step.
151-
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.
144+
### Windows and macOS codesigners only: test code signatures
145+
It is advised to test that the code signature attaches properly prior to tagging by performing the `guix-codesign` step.
146+
However if this is done, once the release has been tagged in the dash-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.
152147

153-
Codesigner only: Commit the detached codesign payloads:
148+
### Windows and macOS codesigners only: Commit the detached codesign payloads
154149

155150
```sh
156151
pushd ~/dashcore-detached-sigs
@@ -165,15 +160,20 @@ git push
165160
popd
166161
```
167162

168-
Non-codesigners: wait for Windows/macOS detached signatures:
163+
### Non-codesigners: wait for Windows and macOS detached signatures
169164

170-
- Once the Windows/macOS builds each have 3 matching signatures, they will be signed with their respective release keys.
165+
- Once the Windows and macOS builds each have 3 matching signatures, they will be signed with their respective release keys.
171166
- Detached signatures will then be committed to the [dash-detached-sigs](https://github.com/dashpay/dash-detached-sigs) repository, which can be combined with the unsigned apps to create signed binaries.
172167

173-
Create (and optionally verify) the codesigned outputs:
174-
- [Codesigning](/contrib/guix/README.md#codesigning)
168+
### Create the codesigned build outputs
169+
- [Codesigning build outputs](/contrib/guix/README.md#codesigning-build-outputs)
170+
171+
### Verify other builders' signatures to your own (optional)
172+
173+
- [Add other builders keys to your gpg keyring, and/or refresh keys](/contrib/builder-keys/README.md)
174+
- [Verifying build output attestations](/contrib/guix/README.md#verifying-build-output-attestations)
175175

176-
Commit your signature for the signed macOS/Windows binaries:
176+
### Commit your codesigned signature to guix.sigs (for the signed macOS/Windows binaries)
177177

178178
```sh
179179
pushd ./guix.sigs
@@ -183,7 +183,7 @@ git push # Assuming you can push to the guix.sigs tree
183183
popd
184184
```
185185

186-
### After 3 or more people have guix-built and their results match:
186+
## After 3 or more people have guix-built and their results match
187187

188188
* [ ] Combine the `all.SHA256SUMS.asc` file from all signers into `SHA256SUMS.asc`:
189189
```sh

0 commit comments

Comments
 (0)