Skip to content

Commit 3f2533c

Browse files
committed
doc: prune release process notes
1 parent 0f9cc4d commit 3f2533c

File tree

1 file changed

+12
-71
lines changed

1 file changed

+12
-71
lines changed

doc/release-process.md

Lines changed: 12 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
Release Process
22
====================
33

4+
Note: I'm only following small subset of this process at the moment and there
5+
are still references to Bitcoin Core.
6+
47
## Branch updates
58

69
### Before every release candidate
710

811
* Update release candidate version in `CMakeLists.txt` (`CLIENT_VERSION_RC`).
912
* Update manpages (after rebuilding the binaries), see [gen-manpages.py](/contrib/devtools/README.md#gen-manpagespy).
10-
* Update bitcoin.conf and commit changes if they exist, see [gen-bitcoin-conf.sh](/contrib/devtools/README.md#gen-bitcoin-confsh).
1113

1214
### Before every major and minor release
1315

@@ -40,7 +42,6 @@ Release Process
4042

4143
#### Before final release
4244

43-
- Merge the release notes from [the wiki](https://github.com/bitcoin-core/bitcoin-devwiki/wiki/) into the branch.
4445
- Ensure the "Needs release note" label is removed from all relevant pull
4546
requests and issues:
4647
https://github.com/bitcoin/bitcoin/issues?q=label%3A%22Needs+release+note%22
@@ -63,13 +64,13 @@ Install Guix using one of the installation methods detailed in
6364
Check out the source code in the following directory hierarchy.
6465

6566
cd /path/to/your/toplevel/build
66-
git clone https://github.com/bitcoin-core/guix.sigs.git
67-
git clone https://github.com/bitcoin-core/bitcoin-detached-sigs.git
67+
git clone https://github.com/sjors/sv2-tp-guix.sigs.git
68+
git clone https://github.com/sjors/sv2-tp-detached-sigs.git
6869
git clone https://github.com/sjors/sv2-tp.git
6970

7071
### Write the release notes
7172

72-
Open a draft of the release notes for collaborative editing at https://github.com/bitcoin-core/bitcoin-devwiki/wiki.
73+
Open a draft of the release notes for collaborative editing at TBD.
7374

7475
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`.
7576

@@ -79,7 +80,7 @@ Generate list of authors:
7980

8081
### Setup and perform Guix builds
8182

82-
Checkout the Bitcoin Core version you'd like to build:
83+
Checkout the Template Provider version you'd like to build:
8384

8485
```sh
8586
pushd ./bitcoin
@@ -200,7 +201,7 @@ cat "$VERSION"/*/all.SHA256SUMS.asc > SHA256SUMS.asc
200201
```
201202

202203

203-
- Upload to the bitcoincore.org server:
204+
- Upload to Github release:
204205
1. The contents of each `./bitcoin/guix-build-${VERSION}/output/${HOST}/` directory.
205206

206207
Guix will output all of the results into host subdirectories, but the SHA256SUMS
@@ -214,80 +215,20 @@ cat "$VERSION"/*/all.SHA256SUMS.asc > SHA256SUMS.asc
214215

215216
3. The `SHA256SUMS.asc` combined signature file you just created.
216217

217-
- After uploading release candidate binaries, notify the bitcoin-core-dev mailing list and
218-
bitcoin-dev group that a release candidate is available for testing. Include a link to the release
219-
notes draft.
220-
221-
- The server will automatically create an OpenTimestamps file and torrent of the directory.
222-
223-
- Optionally help seed this torrent. To get the `magnet:` URI use:
224-
225-
```sh
226-
transmission-show -m <torrent file>
227-
```
228-
229-
Insert the magnet URI into the announcement sent to mailing lists. This permits
230-
people without access to `bitcoincore.org` to download the binary distribution.
231-
Also put it into the `optional_magnetlink:` slot in the YAML file for
232-
bitcoincore.org.
233-
234218
- Archive the release notes for the new version to `doc/release-notes/release-notes-${VERSION}.md`
235219
(branch `master` and branch of the release).
236220

237-
- Update the bitcoincore.org website
238-
239-
- blog post
240-
241-
- maintained versions [table](https://github.com/bitcoin-core/bitcoincore.org/commits/master/_includes/posts/maintenance-table.md)
242-
243-
- RPC documentation update
244-
245-
- See https://github.com/bitcoin-core/bitcoincore.org/blob/master/contrib/doc-gen/
246-
247-
248221
- Update repositories
249222

250-
- Delete post-EOL [release branches](https://github.com/bitcoin/bitcoin/branches/all) and create a tag `v${branch_name}-final`.
251-
252-
- Delete ["Needs backport" labels](https://github.com/bitcoin/bitcoin/labels?q=backport) for non-existing branches.
253-
254-
- Update packaging repo
223+
- Delete post-EOL [release branches](https://github.com/sjors/sv2-tp/branches/all) and create a tag `v${branch_name}-final`.
255224

256-
- Push the flatpak to flathub, e.g. https://github.com/flathub/org.bitcoincore.bitcoin-qt/pull/2
257-
258-
- Push the snap, see https://github.com/bitcoin-core/packaging/blob/main/snap/local/build.md
259-
260-
- Create a [new GitHub release](https://github.com/bitcoin/bitcoin/releases/new) with a link to the archived release notes
225+
- Create a [new GitHub release](https://github.com/sjors/sv2-tp/releases/new) with a link to the archived release notes
261226

262227
- Announce the release:
263228

264-
- bitcoin-dev and bitcoin-core-dev mailing list
265-
266-
- Bitcoin Core announcements list https://bitcoincore.org/en/list/announcements/join/
229+
- SRI Discord
267230

268-
- Bitcoin Core Twitter https://twitter.com/bitcoincoreorg
231+
- bitcoin-dev mailing list
269232

270233
- Celebrate
271234

272-
### Additional information
273-
274-
#### <a name="how-to-calculate-assumed-blockchain-and-chain-state-size"></a>How to calculate `m_assumed_blockchain_size` and `m_assumed_chain_state_size`
275-
276-
Both variables are used as a guideline for how much space the user needs on their drive in total, not just strictly for the blockchain.
277-
Note that all values should be taken from a **fully synced** node and have an overhead of 5-10% added on top of its base value.
278-
279-
To calculate `m_assumed_blockchain_size`, take the size in GiB of these directories:
280-
- For `mainnet` -> the data directory, excluding the `/testnet3`, `/testnet4`, `/signet`, and `/regtest` directories and any overly large files, e.g. a huge `debug.log`
281-
- For `testnet` -> `/testnet3`
282-
- For `testnet4` -> `/testnet4`
283-
- For `signet` -> `/signet`
284-
285-
To calculate `m_assumed_chain_state_size`, take the size in GiB of these directories:
286-
- For `mainnet` -> `/chainstate`
287-
- For `testnet` -> `/testnet3/chainstate`
288-
- For `testnet4` -> `/testnet4/chainstate`
289-
- For `signet` -> `/signet/chainstate`
290-
291-
Notes:
292-
- When taking the size for `m_assumed_blockchain_size`, there's no need to exclude the `/chainstate` directory since it's a guideline value and an overhead will be added anyway.
293-
- The expected overhead for growth may change over time. Consider whether the percentage needs to be changed in response; if so, update it here in this section.

0 commit comments

Comments
 (0)