Skip to content

doc: Add template for empty release notes#24583

Merged
maflcko merged 1 commit intobitcoin:masterfrom
maflcko:2203-docRel-🌟
Apr 5, 2022

Hidden character warning

The head ref may contain hidden characters: "2203-docRel-\ud83c\udf1f"
Merged

doc: Add template for empty release notes#24583
maflcko merged 1 commit intobitcoin:masterfrom
maflcko:2203-docRel-🌟

Conversation

@maflcko
Copy link
Member

@maflcko maflcko commented Mar 16, 2022

  • 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 fanquake added the Docs label Mar 16, 2022
@DrahtBot
Copy link
Contributor

DrahtBot commented Mar 16, 2022

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

Conflicts

No conflicts as of last run.

Copy link
Member

@laanwj laanwj Mar 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

laanwj commented Mar 17, 2022

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).

@maflcko
Copy link
Member Author

maflcko commented Mar 17, 2022

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.".

@laanwj
Copy link
Member

laanwj commented Apr 4, 2022

ACK fa4943e

@maflcko maflcko merged commit 24c6b20 into bitcoin:master Apr 5, 2022
@maflcko
Copy link
Member Author

maflcko commented Apr 5, 2022

@maflcko maflcko deleted the 2203-docRel-🌟 branch April 5, 2022 07:16
sidhujag pushed a commit to syscoin/syscoin that referenced this pull request Apr 5, 2022
@bitcoin bitcoin locked and limited conversation to collaborators Apr 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants