mirror of
https://github.com/bitcoin/bitcoin.git
synced 2024-11-19 09:53:47 +01:00
doc: Add template for empty release notes
This commit is contained in:
parent
bf2c0fb2a2
commit
fa4943e8df
99
doc/release-notes-empty-template.md
Normal file
99
doc/release-notes-empty-template.md
Normal file
@ -0,0 +1,99 @@
|
|||||||
|
*The release notes draft is a temporary file that can be added to by anyone. See
|
||||||
|
[/doc/developer-notes.md#release-notes](/doc/developer-notes.md#release-notes)
|
||||||
|
for the process.*
|
||||||
|
|
||||||
|
*version* Release Notes Draft
|
||||||
|
===============================
|
||||||
|
|
||||||
|
Bitcoin Core version *version* is now available from:
|
||||||
|
|
||||||
|
<https://bitcoincore.org/bin/bitcoin-core-*version*/>
|
||||||
|
|
||||||
|
This release includes new features, various bug fixes and performance
|
||||||
|
improvements, as well as updated translations.
|
||||||
|
|
||||||
|
Please report bugs using the issue tracker at GitHub:
|
||||||
|
|
||||||
|
<https://github.com/bitcoin/bitcoin/issues>
|
||||||
|
|
||||||
|
To receive security and update notifications, please subscribe to:
|
||||||
|
|
||||||
|
<https://bitcoincore.org/en/list/announcements/join/>
|
||||||
|
|
||||||
|
How to Upgrade
|
||||||
|
==============
|
||||||
|
|
||||||
|
If you are running an older version, shut it down. Wait until it has completely
|
||||||
|
shut down (which might take a few minutes in some cases), then run the
|
||||||
|
installer (on Windows) or just copy over `/Applications/Bitcoin-Qt` (on Mac)
|
||||||
|
or `bitcoind`/`bitcoin-qt` (on Linux).
|
||||||
|
|
||||||
|
Upgrading directly from a version of Bitcoin Core that has reached its EOL is
|
||||||
|
possible, but it might take some time if the data directory needs to be migrated. Old
|
||||||
|
wallet versions of Bitcoin Core are generally supported.
|
||||||
|
|
||||||
|
Compatibility
|
||||||
|
==============
|
||||||
|
|
||||||
|
Bitcoin Core is supported and extensively tested on operating systems
|
||||||
|
using the Linux kernel, macOS 10.15+, and Windows 7 and newer. Bitcoin
|
||||||
|
Core should also work on most other Unix-like systems but is not as
|
||||||
|
frequently tested on them. It is not recommended to use Bitcoin Core on
|
||||||
|
unsupported systems.
|
||||||
|
|
||||||
|
Notable changes
|
||||||
|
===============
|
||||||
|
|
||||||
|
P2P and network changes
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
Updated RPCs
|
||||||
|
------------
|
||||||
|
|
||||||
|
|
||||||
|
Changes to wallet related RPCs can be found in the Wallet section below.
|
||||||
|
|
||||||
|
New RPCs
|
||||||
|
--------
|
||||||
|
|
||||||
|
Build System
|
||||||
|
------------
|
||||||
|
|
||||||
|
Updated settings
|
||||||
|
----------------
|
||||||
|
|
||||||
|
|
||||||
|
Changes to GUI or wallet related settings can be found in the GUI or Wallet section below.
|
||||||
|
|
||||||
|
New settings
|
||||||
|
------------
|
||||||
|
|
||||||
|
Tools and Utilities
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
Wallet
|
||||||
|
------
|
||||||
|
|
||||||
|
GUI changes
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Low-level changes
|
||||||
|
=================
|
||||||
|
|
||||||
|
RPC
|
||||||
|
---
|
||||||
|
|
||||||
|
Tests
|
||||||
|
-----
|
||||||
|
|
||||||
|
*version* change log
|
||||||
|
====================
|
||||||
|
|
||||||
|
Credits
|
||||||
|
=======
|
||||||
|
|
||||||
|
Thanks to everyone who directly contributed to this release:
|
||||||
|
|
||||||
|
|
||||||
|
As well as to everyone that helped with translations on
|
||||||
|
[Transifex](https://www.transifex.com/bitcoin/bitcoin/).
|
@ -1,17 +1,7 @@
|
|||||||
*After branching off for a major version release of Bitcoin Core, use this
|
|
||||||
template to create the initial release notes draft.*
|
|
||||||
|
|
||||||
*The release notes draft is a temporary file that can be added to by anyone. See
|
*The release notes draft is a temporary file that can be added to by anyone. See
|
||||||
[/doc/developer-notes.md#release-notes](/doc/developer-notes.md#release-notes)
|
[/doc/developer-notes.md#release-notes](/doc/developer-notes.md#release-notes)
|
||||||
for the process.*
|
for the process.*
|
||||||
|
|
||||||
*Create the draft, named* "*version* Release Notes Draft"
|
|
||||||
*(e.g. "23.0 Release Notes Draft"), as a collaborative wiki in:*
|
|
||||||
|
|
||||||
https://github.com/bitcoin-core/bitcoin-devwiki/wiki/
|
|
||||||
|
|
||||||
*Before the final release, move the notes back to this git repository.*
|
|
||||||
|
|
||||||
*version* Release Notes Draft
|
*version* Release Notes Draft
|
||||||
===============================
|
===============================
|
||||||
|
|
||||||
@ -54,9 +44,51 @@ unsupported systems.
|
|||||||
Notable changes
|
Notable changes
|
||||||
===============
|
===============
|
||||||
|
|
||||||
Example item
|
P2P and network changes
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
Updated RPCs
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
|
||||||
|
Changes to wallet related RPCs can be found in the Wallet section below.
|
||||||
|
|
||||||
|
New RPCs
|
||||||
|
--------
|
||||||
|
|
||||||
|
Build System
|
||||||
|
------------
|
||||||
|
|
||||||
|
Updated settings
|
||||||
|
----------------
|
||||||
|
|
||||||
|
|
||||||
|
Changes to GUI or wallet related settings can be found in the GUI or Wallet section below.
|
||||||
|
|
||||||
|
New settings
|
||||||
|
------------
|
||||||
|
|
||||||
|
Tools and Utilities
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
Wallet
|
||||||
|
------
|
||||||
|
|
||||||
|
GUI changes
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Low-level changes
|
||||||
|
=================
|
||||||
|
|
||||||
|
RPC
|
||||||
|
---
|
||||||
|
|
||||||
|
Tests
|
||||||
|
-----
|
||||||
|
|
||||||
|
*version* change log
|
||||||
|
====================
|
||||||
|
|
||||||
Credits
|
Credits
|
||||||
=======
|
=======
|
||||||
|
|
||||||
|
@ -47,13 +47,15 @@ Release Process
|
|||||||
#### After branch-off (on the major release branch)
|
#### After branch-off (on the major release branch)
|
||||||
|
|
||||||
- Update the versions.
|
- Update the versions.
|
||||||
|
- Create the draft, named "*version* Release Notes Draft", as a [collaborative wiki](https://github.com/bitcoin-core/bitcoin-devwiki/wiki/_new).
|
||||||
|
- Clear the release notes: `cp doc/release-notes-empty-template.md doc/release-notes.md`
|
||||||
- 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.
|
- 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.
|
||||||
- Translations on Transifex
|
- Translations on Transifex
|
||||||
- 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.
|
- 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.
|
||||||
|
|
||||||
#### Before final release
|
#### Before final release
|
||||||
|
|
||||||
- Merge the release notes from the wiki into the branch.
|
- Merge the release notes from [the wiki](https://github.com/bitcoin-core/bitcoin-devwiki/wiki/) into the branch.
|
||||||
- Ensure the "Needs release note" label is removed from all relevant pull requests and issues.
|
- Ensure the "Needs release note" label is removed from all relevant pull requests and issues.
|
||||||
|
|
||||||
#### Tagging a release (candidate)
|
#### Tagging a release (candidate)
|
||||||
|
Loading…
Reference in New Issue
Block a user