Skip to content

Commit a0d5e0d

Browse files
committed
[doc] Cleanup release-process documentation
1 parent a1d623d commit a0d5e0d

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

doc/release-process.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,67 @@
11
Release Process
22
====================
33

4-
* update translations (ping wumpus, Diapolo or tcatm on IRC)
5-
* see https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex
4+
* Update translations (ping wumpus, Diapolo or tcatm on IRC) see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex)
5+
* Update [bips.md](bips.md) to account for changes since the last release.
66

77
* * *
88

9-
###first time only or for new builders, check out the source in the following directory hierarchy
9+
###First time / New builders
10+
Check out the source code in the following directory hierarchy.
1011

1112
cd /path/to/your/toplevel/build
1213
git clone https://github.com/bitcoin/gitian.sigs.git
14+
git clone https://github.com/bitcoin/bitcoin-detached-sigs.git
1315
git clone https://github.com/devrandom/gitian-builder.git
1416
git clone https://github.com/bitcoin/bitcoin.git
1517

16-
###for bitcoin maintainers/release engineers, update (commit) version in sources
18+
###Bitcoin maintainers/release engineers, update (commit) version in sources
1719

1820
pushd ./bitcoin
1921
contrib/verifysfbinaries/verify.sh
2022
doc/README*
2123
share/setup.nsi
2224
src/clientversion.h (change CLIENT_VERSION_IS_RELEASE to true)
2325

24-
###for bitcoin maintainers/release engineers, tag version in git
26+
# tag version in git
2527

2628
git tag -s v(new version, e.g. 0.8.0)
2729

28-
###for bitcoin maintainers/release engineers, write release notes. git shortlog helps a lot, for example:
30+
# write release notes. git shortlog helps a lot, for example:
2931

3032
git shortlog --no-merges v(current version, e.g. 0.7.2)..v(new version, e.g. 0.8.0)
3133
popd
3234

3335
* * *
3436

35-
###update gitian, gitian.sigs, checkout bitcoin version, and perform gitian builds
37+
###Setup and perform gitian builds
3638

37-
To ensure your gitian descriptors are accurate for direct reference for gbuild, below, run the following from a directory containing the bitcoin source:
39+
Setup gitian descriptors:
3840

3941
pushd ./bitcoin
4042
export SIGNER=(your gitian key, ie bluematt, sipa, etc)
4143
export VERSION=(new version, e.g. 0.8.0)
4244
git checkout v${VERSION}
4345
popd
4446

45-
Ensure your gitian.sigs are up-to-date if you wish to gverify your builds against other gitian signatures:
47+
Ensure your gitian.sigs are up-to-date if you wish to gverify your builds against other gitian signatures.
4648

4749
pushd ./gitian.sigs
4850
git pull
4951
popd
5052

51-
Ensure your gitian-builder sources are up-to-date to take advantage of the new caching features of gitian (`e9741525c` or later is recommended)
53+
Ensure gitian-builder is up-to-date to take advantage of new caching features (`e9741525c` or later is recommended).
5254

5355
pushd ./gitian-builder
5456
git pull
5557

56-
###fetch and create inputs: (first time, or when dependency versions change)
58+
###Fetch and create inputs: (first time, or when dependency versions change)
5759

5860
mkdir -p inputs
5961
wget -P inputs https://bitcoincore.org/cfields/osslsigncode-Backports-to-1.7.1.patch
6062
wget -P inputs http://downloads.sourceforge.net/project/osslsigncode/osslsigncode/osslsigncode-1.7.1.tar.gz
6163

62-
Register and download the Apple SDK: (see OSX Readme for details)
64+
Register and download the Apple SDK: see [OSX readme](README_osx.txt) for details.
6365

6466
https://developer.apple.com/devcenter/download.action?path=/Developer_Tools/xcode_6.1.1/xcode_6.1.1.dmg
6567

@@ -75,15 +77,11 @@ By default, gitian will fetch source files as needed. To cache them ahead of tim
7577

7678
Only missing files will be fetched, so this is safe to re-run for each build.
7779

78-
Clone the detached-sigs repository:
79-
80-
popd
81-
git clone https://github.com/bitcoin/bitcoin-detached-sigs.git
82-
pushd ./bitcoin-builder
83-
84-
NOTE: Offline builds must use the --url flag to ensure gitian fetches only from local URLs.
85-
For example: ./bin/bguild --url bitcoin=/path/to/bitcoin,signature=/path/to/sigs {rest of arguments}
86-
The following gbuild invocations DO NOT DO THIS by default.
80+
NOTE: Offline builds must use the --url flag to ensure gitian fetches only from local URLs. For example:
81+
```
82+
./bin/bguild --url bitcoin=/path/to/bitcoin,signature=/path/to/sigs {rest of arguments}
83+
```
84+
The gbuild invocations below <b>DO NOT DO THIS</b> by default.
8785

8886
###Build (and optionally verify) Bitcoin Core for Linux, Windows, and OS X:
8987

@@ -126,8 +124,9 @@ Commit your signature to gitian.sigs:
126124
popd
127125

128126
Wait for Windows/OSX detached signatures:
127+
129128
Once the Windows/OSX builds each have 3 matching signatures, they will be signed with their respective release keys.
130-
Detached signatures will then be committed to the bitcoin-detached-sigs repository, which can be combined with the unsigned apps to create signed binaries.
129+
Detached signatures will then be committed to the [bitcoin-detached-sigs](https://github.com/bitcoin/bitcoin-detached-sigs) repository, which can be combined with the unsigned apps to create signed binaries.
131130

132131
Create (and optionally verify) the signed OSX binary:
133132

@@ -176,14 +175,14 @@ Note: check that SHA256SUMS itself doesn't end up in SHA256SUMS, which is a spur
176175
- Update bitcoin.org version
177176

178177
- First, check to see if the Bitcoin.org maintainers have prepared a
179-
release: https://github.com/bitcoin/bitcoin.org/labels/Releases
178+
release: https://github.com/bitcoin-dot-org/bitcoin.org/labels/Releases
180179

181180
- If they have, it will have previously failed their Travis CI
182181
checks because the final release files weren't uploaded.
183182
Trigger a Travis CI rebuild---if it passes, merge.
184183

185184
- If they have not prepared a release, follow the Bitcoin.org release
186-
instructions: https://github.com/bitcoin/bitcoin.org#release-notes
185+
instructions: https://github.com/bitcoin-dot-org/bitcoin.org#release-notes
187186

188187
- After the pull request is merged, the website will automatically show the newest version within 15 minutes, as well
189188
as update the OS download links. Ping @saivann/@harding (saivann/harding on Freenode) in case anything goes wrong

0 commit comments

Comments
 (0)