Skip to content

Commit fa4943e

Browse files
author
MarcoFalke
committed
doc: Add template for empty release notes
1 parent bf2c0fb commit fa4943e

File tree

3 files changed

+145
-12
lines changed

3 files changed

+145
-12
lines changed

doc/release-notes-empty-template.md

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
*The release notes draft is a temporary file that can be added to by anyone. See
2+
[/doc/developer-notes.md#release-notes](/doc/developer-notes.md#release-notes)
3+
for the process.*
4+
5+
*version* Release Notes Draft
6+
===============================
7+
8+
Bitcoin Core version *version* is now available from:
9+
10+
<https://bitcoincore.org/bin/bitcoin-core-*version*/>
11+
12+
This release includes new features, various bug fixes and performance
13+
improvements, as well as updated translations.
14+
15+
Please report bugs using the issue tracker at GitHub:
16+
17+
<https://github.com/bitcoin/bitcoin/issues>
18+
19+
To receive security and update notifications, please subscribe to:
20+
21+
<https://bitcoincore.org/en/list/announcements/join/>
22+
23+
How to Upgrade
24+
==============
25+
26+
If you are running an older version, shut it down. Wait until it has completely
27+
shut down (which might take a few minutes in some cases), then run the
28+
installer (on Windows) or just copy over `/Applications/Bitcoin-Qt` (on Mac)
29+
or `bitcoind`/`bitcoin-qt` (on Linux).
30+
31+
Upgrading directly from a version of Bitcoin Core that has reached its EOL is
32+
possible, but it might take some time if the data directory needs to be migrated. Old
33+
wallet versions of Bitcoin Core are generally supported.
34+
35+
Compatibility
36+
==============
37+
38+
Bitcoin Core is supported and extensively tested on operating systems
39+
using the Linux kernel, macOS 10.15+, and Windows 7 and newer. Bitcoin
40+
Core should also work on most other Unix-like systems but is not as
41+
frequently tested on them. It is not recommended to use Bitcoin Core on
42+
unsupported systems.
43+
44+
Notable changes
45+
===============
46+
47+
P2P and network changes
48+
-----------------------
49+
50+
Updated RPCs
51+
------------
52+
53+
54+
Changes to wallet related RPCs can be found in the Wallet section below.
55+
56+
New RPCs
57+
--------
58+
59+
Build System
60+
------------
61+
62+
Updated settings
63+
----------------
64+
65+
66+
Changes to GUI or wallet related settings can be found in the GUI or Wallet section below.
67+
68+
New settings
69+
------------
70+
71+
Tools and Utilities
72+
-------------------
73+
74+
Wallet
75+
------
76+
77+
GUI changes
78+
-----------
79+
80+
Low-level changes
81+
=================
82+
83+
RPC
84+
---
85+
86+
Tests
87+
-----
88+
89+
*version* change log
90+
====================
91+
92+
Credits
93+
=======
94+
95+
Thanks to everyone who directly contributed to this release:
96+
97+
98+
As well as to everyone that helped with translations on
99+
[Transifex](https://www.transifex.com/bitcoin/bitcoin/).

doc/release-notes.md

+43-11
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,7 @@
1-
*After branching off for a major version release of Bitcoin Core, use this
2-
template to create the initial release notes draft.*
3-
41
*The release notes draft is a temporary file that can be added to by anyone. See
52
[/doc/developer-notes.md#release-notes](/doc/developer-notes.md#release-notes)
63
for the process.*
74

8-
*Create the draft, named* "*version* Release Notes Draft"
9-
*(e.g. "23.0 Release Notes Draft"), as a collaborative wiki in:*
10-
11-
https://github.com/bitcoin-core/bitcoin-devwiki/wiki/
12-
13-
*Before the final release, move the notes back to this git repository.*
14-
155
*version* Release Notes Draft
166
===============================
177

@@ -54,9 +44,51 @@ unsupported systems.
5444
Notable changes
5545
===============
5646

57-
Example item
47+
P2P and network changes
48+
-----------------------
49+
50+
Updated RPCs
51+
------------
52+
53+
54+
Changes to wallet related RPCs can be found in the Wallet section below.
55+
56+
New RPCs
57+
--------
58+
59+
Build System
60+
------------
61+
62+
Updated settings
63+
----------------
64+
65+
66+
Changes to GUI or wallet related settings can be found in the GUI or Wallet section below.
67+
68+
New settings
5869
------------
5970

71+
Tools and Utilities
72+
-------------------
73+
74+
Wallet
75+
------
76+
77+
GUI changes
78+
-----------
79+
80+
Low-level changes
81+
=================
82+
83+
RPC
84+
---
85+
86+
Tests
87+
-----
88+
89+
*version* change log
90+
====================
91+
6092
Credits
6193
=======
6294

doc/release-process.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,15 @@ Release Process
4747
#### After branch-off (on the major release branch)
4848

4949
- Update the versions.
50+
- Create the draft, named "*version* Release Notes Draft", as a [collaborative wiki](https://github.com/bitcoin-core/bitcoin-devwiki/wiki/_new).
51+
- Clear the release notes: `cp doc/release-notes-empty-template.md doc/release-notes.md`
5052
- 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.
5153
- Translations on Transifex
5254
- 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.
5355

5456
#### Before final release
5557

56-
- Merge the release notes from the wiki into the branch.
58+
- Merge the release notes from [the wiki](https://github.com/bitcoin-core/bitcoin-devwiki/wiki/) into the branch.
5759
- Ensure the "Needs release note" label is removed from all relevant pull requests and issues.
5860

5961
#### Tagging a release (candidate)

0 commit comments

Comments
 (0)