doc: Add template for empty release notes #24583

pull MarcoFalke wants to merge 1 commits into bitcoin:master from MarcoFalke:2203-docRel-🌟 changing 3 files +145 −12

MarcoFalke commented at 1:09 PM on March 16, 2022: member
- 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)
fanquake added the label Docs on Mar 16, 2022
DrahtBot commented at 4:29 PM on March 16, 2022: member



The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.



Conflicts

No conflicts as of last run.
in doc/release-notes-empty-template.md:92 in fa3e84936e outdated
```
  84 | +---
  85 | +
  86 | +Tests
  87 | +-----
  88 | +
  89 | +Credits
```
laanwj commented at 10:45 AM on March 17, 2022:

We also completely don't mention the per-PR changelog here. Is this in purpose?

I'm sometimes not clear on whether we still need it. The release notes tend to be written to such a level of detail nowadays (even low-level changes) which used to be the point of the detailed list.

MarcoFalke commented at 1:17 PM on March 17, 2022:

I think it can't hurt, as it is easy to skip the section if not needed?

Added the section to the template for now.
laanwj commented at 10:50 AM on March 17, 2022: member

Concept ACK

Also, this ensures that the "no duplication" note isn't deleted again.

Which note are you referring to here? (the link refers to "Updated settings", which doesn't make it clearer to me).
MarcoFalke commented at 1:11 PM on March 17, 2022: member

Which note are you referring to here? (the link refers to "Updated settings", which doesn't make it clearer to me).

It is " Changes to wallet related RPCs can be found in the Wallet section below.".
doc: Add template for empty release notes fa4943e8df
MarcoFalke force-pushed on Mar 17, 2022
laanwj commented at 2:13 PM on April 4, 2022: member

ACK fa4943e8df2e1048a5030f1d93776ca2b9da7b8a
MarcoFalke merged this on Apr 5, 2022
MarcoFalke closed this on Apr 5, 2022
MarcoFalke commented at 7:16 AM on April 5, 2022: member

Adjusted the release notes on the wiki with this: https://github.com/bitcoin-core/bitcoin-devwiki/wiki/23.0-Release-Notes-draft/_compare/5b55f7b34ce5a10a30ed9d3656170a3aa45c97be...7037802bf14f4bdfb2216740e2f8f4fe17afaf1a
MarcoFalke deleted the branch on Apr 5, 2022
sidhujag referenced this in commit 7e407b5b59 on Apr 5, 2022
DrahtBot locked this on Apr 5, 2023

Contributors

Labels

doc: Add template for empty release notes #24583

Conflicts