Skip to content

Commit cf856ee

Browse files
MarcoFalkeknst
authored andcommitted
Merge bitcoin#24583: doc: Add template for empty release notes
fa4943e doc: Add template for empty release notes (MarcoFalke) Pull request description: * Move release process notes from the release notes to the release process documentation * Clarify that wallet RPC or Settings related release notes snippets should not be duplicated. I think it should be sufficient to only mention them in the wallet section and leave them out from the general RPC section. * Create an empty template to ensure the release notes can be cleared with a single `cp` command. Also, this ensures that the "no duplication" note isn't deleted again. (We used to have it in at least the 22.0 and 21.0 release notes: https://github.com/bitcoin/bitcoin/blob/master/doc/release-notes/release-notes-0.21.0.md#updated-settings , but it was lost in the 23.0 notes) ACKs for top commit: laanwj: ACK fa4943e Tree-SHA512: 808e100ee1e371f7746a479ddfb237c6895935cffefc0e49033505492a03288013d5c20386af30f2a7dca8ad0c0628bdb6673dcb5cc4fcf4d0183b0ec65ce941
1 parent c8a7ef6 commit cf856ee

File tree

3 files changed

+102
-2
lines changed

3 files changed

+102
-2
lines changed
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
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+
# Dash Core version *version*
6+
===============================
7+
8+
This is a new minor version release, bringing various bugfixes and performance improvements.
9+
This release is **optional** for all nodes, although recommended.
10+
11+
Please report bugs using the issue tracker at GitHub:
12+
13+
<https://github.com/dashpay/dash/issues>
14+
15+
16+
# Upgrading and downgrading
17+
18+
## How to Upgrade
19+
20+
If you are running an older version, shut it down. Wait until it has completely
21+
shut down (which might take a few minutes in some cases), then run the
22+
installer (on Windows) or just copy over /Applications/Dash-Qt (on Mac) or
23+
dashd/dash-qt (on Linux).
24+
25+
## Downgrade warning
26+
27+
### Downgrade to a version < *version*
28+
29+
Downgrading to a version older than *version* may not be supported, and will
30+
likely require a reindex.
31+
32+
# Release Notes
33+
34+
Notable changes
35+
===============
36+
37+
P2P and network changes
38+
-----------------------
39+
40+
Updated RPCs
41+
------------
42+
43+
44+
Changes to wallet related RPCs can be found in the Wallet section below.
45+
46+
New RPCs
47+
--------
48+
49+
Build System
50+
------------
51+
52+
Updated settings
53+
----------------
54+
55+
56+
Changes to GUI or wallet related settings can be found in the GUI or Wallet section below.
57+
58+
New settings
59+
------------
60+
61+
Tools and Utilities
62+
-------------------
63+
64+
Wallet
65+
------
66+
67+
GUI changes
68+
-----------
69+
70+
Low-level changes
71+
=================
72+
73+
RPC
74+
---
75+
76+
Tests
77+
-----
78+
79+
See detailed [set of changes][set-of-changes].
80+
81+
# Credits
82+
83+
Thanks to everyone who directly contributed to this release:
84+
85+
-
86+
-
87+
-
88+
89+
As well as everyone that submitted issues, reviewed pull requests and helped
90+
debug the release candidates.
91+
92+
# Older releases
93+
94+
These releases are considered obsolete. Old release notes can be found here:
95+
96+
-
97+
-
98+
-
99+
100+
[set-of-changes]: https://github.com/dashpay/dash/compare/*version*...dashpay:*version*

doc/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,4 +122,4 @@ These releases are considered obsolete. Old release notes can be found here:
122122
- [v0.10.x](https://github.com/dashpay/dash/blob/master/doc/release-notes/dash/release-notes-0.10.0.md) released Sep/25/2014
123123
- [v0.9.x](https://github.com/dashpay/dash/blob/master/doc/release-notes/dash/release-notes-0.9.0.md) released Mar/13/2014
124124

125-
[set-of-changes]: https://github.com/dashpay/dash/compare/v22.1.2...dashpay:v22.1.3
125+
[set-of-changes]: https://github.com/dashpay/dash/compare/v22.1.2...dashpay:v22.1.3

doc/release-process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Before every minor and major release:
99
* [ ] Review ["Needs backport" labels](https://github.com/dashpay/dash/labels?q=backport).
1010
* [ ] Update DIPs with any changes introduced by this release (see [this pull request](https://github.com/dashpay/dips/pull/142) for an example)
1111
* [ ] Update version in `configure.ac` (don't forget to set `CLIENT_VERSION_IS_RELEASE` to `true`)
12-
* [ ] Write release notes (see below)
12+
* [ ] Write release notes (see below). To clear the release notes: `cp doc/release-notes-empty-template.md doc/release-notes.md`
1313
* [ ] Update `src/chainparams.cpp` `nMinimumChainWork` with information from the `getblockchaininfo` rpc.
1414
* [ ] Update `src/chainparams.cpp` `defaultAssumeValid` with information from the `getblockhash` rpc.
1515
- The selected value must not be orphaned so it may be useful to set the value two blocks back from the tip.

0 commit comments

Comments
 (0)