[Docs] Release process updates #15607

jonatack commented at 2:11 PM on March 15, 2019: member

Updates to release-notes.md:

Write an introduction explaining how to use release-notes.md as a template for the release notes draft wiki for collaborative editing at https://github.com/bitcoin-core/bitcoin-devwiki/wiki, as seen for the 0.17.0 and 0.18.0 releases.

Updates to release-process.md:

Create a release notes draft wiki at https://github.com/bitcoin-core/bitcoin-devwiki/wiki.
As per http://www.erisian.com.au/bitcoin-core-dev/log-2019-03-28.html#l-342, for the period during which the release notes are being edited on the wiki, the version on the branch should be wiped and replaced with a link to the wiki which should be used for all announcements until final.
Before -final, remove the "Needs release note" label from relevant PRs/issues and merge the release notes from the wiki into the branch.
Create a pinned meta-issue dedicated to testing the release candidate and communicate it in release announcements where useful. The former is done in practice (e.g. #15555, #14902) and the latter addresses the discussion here yesterday: https://x0f.org/web/statuses/101753569204220416.
Reorganise the headers in the Branch Updates section.
Update the version numbers in the examples.
Adapt and merge in the updates in #15692.

fanquake added the label Docs on Mar 15, 2019

in doc/release-process.md:330 in 37825295dd outdated

 326 | @@ -325,6 +327,8 @@ bitcoin.org (see below for bitcoin.org update instructions).
 327 |  
 328 |        - Create a [new GitHub release](https://github.com/bitcoin/bitcoin/releases/new) with a link to the archived release notes.
 329 |  
 330 | +      - Create an issue dedicated to testing the release and provide the link to it in the release announcements where useful

MarcoFalke commented at 2:16 PM on March 15, 2019:

I don't like having a single issue/thread for all issues with a release. It could be a meta issue, but all bug reports should go into their own issue.

jonatack commented at 2:36 PM on March 15, 2019:

Thank you for reviewing. Prefer re-word (e.g. "meta issue" or "issue for release ACKs") or remove?

jonatack commented at 3:06 PM on March 15, 2019:

Updated.

jonatack renamed this:
~~Release process updates~~
[Docs] Release process updates
on Mar 15, 2019

in doc/release-process.md:330 in 310080b43a outdated

 326 | @@ -325,6 +327,8 @@ bitcoin.org (see below for bitcoin.org update instructions).
 327 |  
 328 |        - Create a [new GitHub release](https://github.com/bitcoin/bitcoin/releases/new) with a link to the archived release notes.
 329 |  
 330 | +      - Create an pinned meta-issue for testing the release and provide the link to it in the release announcements where useful

fanquake commented at 12:29 AM on March 16, 2019:

nit: a pinned meta-issue

fanquake commented at 12:31 AM on March 16, 2019: member

utACK. Please squash your changes.

jonatack force-pushed on Mar 16, 2019

jonatack commented at 12:55 PM on March 16, 2019: member

Updated and squashed. Thanks for reviewing :+1:

fanquake commented at 12:51 PM on March 17, 2019: member

utACK ff41428

in doc/release-process.md:45 in ff414288b5 outdated

  41 | @@ -42,6 +42,8 @@ Check out the source code in the following directory hierarchy.
  42 |  
  43 |  ### Bitcoin maintainers/release engineers, suggestion for writing release notes
  44 |  
  45 | +Open a release notes draft for collaborative editing at https://github.com/bitcoin-core/bitcoin-devwiki/wiki

laanwj commented at 11:15 AM on March 20, 2019:

Good to mention. Though if you do, I think it needs to also mention merging this wiki back into the branch just before -final

fanquake commented at 12:35 PM on March 20, 2019: member

Could you also mention somewhere that all PRs/issues should have the "Needs release note" label removed after -final.

jonatack force-pushed on Mar 22, 2019

jonatack commented at 12:29 PM on March 22, 2019: member

Added both suggestions as "Before the final release". We can stipulate the release notes merge before -final and the labels removal after -final if needed.

jonatack closed this on Mar 22, 2019

jonatack reopened this on Mar 22, 2019

jonatack commented at 12:38 PM on March 22, 2019: member

Also added #15555 as an example for the meta issue because it now mentions:

"Let us know which version you tested on which operating system. If you find an issue, please search Github for known issues first and then open a new Github issue."

jonatack force-pushed on Mar 28, 2019

jonatack commented at 10:15 PM on March 28, 2019: member

Updated as per core dev IRC discussion http://www.erisian.com.au/bitcoin-core-dev/log-2019-03-28.html#l-342:

"For the period during which the notes are being edited on the wiki, the version on the branch should be wiped and replaced with a link to the wiki which should be used for all announcements until final."

in doc/release-process.md:73 in b9bdfe3e07 outdated

  44 | +### Write the release notes
  45 |  
  46 | -Write release notes. git shortlog helps a lot, for example:
  47 | +Open a draft of the release notes for collaborative editing at https://github.com/bitcoin-core/bitcoin-devwiki/wiki.
  48 | +
  49 | +For the period during which the notes are being edited on the wiki, the version on the branch should be wiped and replaced with a link to the wiki which should be used for all announcements until `-final`.

MarcoFalke commented at 10:33 PM on March 28, 2019:

The steps to be done pre-branch-off should be mentioned above, no?

See the commit in #15692, which you are welcome to steal.

jonatack commented at 10:47 PM on March 28, 2019:

Ok :+1:

jonatack commented at 12:48 PM on March 29, 2019:

Stolen, adapted/merged, rebased.

jonatack force-pushed on Mar 29, 2019

DrahtBot commented at 2:00 PM on March 29, 2019: 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.md:1 in dba0fbb2f1 outdated

   0 | @@ -1,5 +1,4 @@
   1 | -(note: this is a temporary file, to be added-to by anybody, and moved to
   2 | -release-notes at release time)
   3 | +*(Note: this is a temporary file to be added-to by anybody. See [/doc/developer-notes.md#release-notes](/doc/developer-notes.md#release-notes) for the process. After branching off for a major version release of Bitcoin Core, release notes are drafted in a collaborative wiki at https://github.com/bitcoin-core/bitcoin-devwiki/wiki/*version*-Release-Notes-Draft). Before the final release, the notes need to be moved to [/doc/release-notes/](/doc/release-notes/).*

MarcoFalke commented at 6:38 PM on April 15, 2019:

Could make this multiline?

*This is a temporary file to be added-to by anybody. See
[/doc/developer-notes.md#release-notes](/doc/developer-notes.md#release-notes)
for the process.*

*After branching off for a major version release of Bitcoin Core, release notes
are drafted in a collaborative wiki at*
https://github.com/bitcoin-core/bitcoin-devwiki/wiki/*version*-Release-Notes-Draft.
*Before the final release, the notes need to be moved back to this git
repository.*

jonatack commented at 9:14 AM on April 16, 2019:

Done, and used your changes to the writing. Also made the wiki link point to a functional url and did another writing pass on release-notes.md. Several rebases improving the markdown formatting. Added release-notes.md to the commit message. No additional changes made to release-process.md.

jonatack force-pushed on Apr 16, 2019

DrahtBot added the label Needs rebase on Apr 29, 2019

jonatack force-pushed on May 1, 2019

jonatack commented at 10:45 AM on May 1, 2019: member

rebased

DrahtBot removed the label Needs rebase on May 1, 2019

in doc/release-process.md:35 in df173441ea outdated

  31 |  * In `configure.ac` and `build_msvc/bitcoin_config.h` on _a new release branch_ (see [this commit](https://github.com/bitcoin/bitcoin/commit/742f7dd972fca3dd4a33cfff90bf901b71a687e7)):
  32 |    - update `CLIENT_VERSION_MINOR` version
  33 |    - set `CLIENT_VERSION_REVISION` to `0`
  34 |    - set `CLIENT_VERSION_IS_RELEASE` to `true`
  35 | +* Before branching off the release, clear the release notes and move them to the wiki (see "Write the release notes" below).
  36 | +* After branching off the release:

MarcoFalke commented at 1:01 PM on May 1, 2019:

Instead of nested lists with *, could use some headings? I.e.

## Branch updates

### Before every release candidate
...

### Before every major release

#### Before branch-off

...

#### After branch off (on master)

#### After branch off (on the major release branch)

## Building

### First time/New builders

jonatack commented at 3:09 PM on May 10, 2019:

Done.

in doc/release-process.md:72 in df173441ea outdated

  71 | -Tag version (or release candidate) in git
  72 | +Tag the version (or release candidate) in git:
  73 |  
  74 |      git tag -s v(new version, e.g. 0.8.0)
  75 |  
  76 | +Before the final release:

MarcoFalke commented at 1:52 PM on May 1, 2019:

Those bullet points should be moved up to the "Branch updates" section? You could link to the "writing release notes" from there

jonatack commented at 3:10 PM on May 10, 2019:

Done

in doc/release-process.md:346 in df173441ea outdated

 340 | @@ -328,7 +341,9 @@ bitcoin.org (see below for bitcoin.org update instructions).
 341 |  
 342 |        - Archive release notes for the new version to `doc/release-notes/` (branch `master` and branch of the release)
 343 |  
 344 | -      - Create a [new GitHub release](https://github.com/bitcoin/bitcoin/releases/new) with a link to the archived release notes.
 345 | +      - Create a [new GitHub release](https://github.com/bitcoin/bitcoin/releases/new) with a link to the archived release notes
 346 | +
 347 | +      - Create a pinned meta-issue for testing the release (see [here](https://github.com/bitcoin/bitcoin/issues/15555) for an example) and provide a link to it in the release announcements where useful

MarcoFalke commented at 1:55 PM on May 1, 2019:

This is not done after the release, but before. Also, I don't like the idea of accumulating bugs of completely different kinds in a single issue. This makes it harder to track. Idk I am ~0 on this

jonatack commented at 3:11 PM on May 10, 2019:

Changed "for testing the release" to "for testing the release candidate".

MarcoFalke commented at 1:57 PM on May 1, 2019: member

ACK beside nits. Thanks for sticking with this

jonatack force-pushed on May 10, 2019

in doc/release-process.md:51 in 7d9af39473 outdated

  63 | +
  64 | +- Update versions and link to the release notes draft in `doc/release-notes.md`.
  65 | +
  66 | +#### Before final release
  67 | +
  68 | +- Merge the release notes from the wiki into the branch.

jonatack commented at 3:17 PM on May 10, 2019:

Does this line conflict with the instructions in line 351 below?

"Archive the release notes for the new version to doc/release-notes/ (branch master and branch of the release)"

jonatack commented at 3:18 PM on May 10, 2019: member

Thanks for reviewing @MarcoFalke. Kept the new commits separate for now, will squash if these changes are all good.

in doc/release-process.md:14 in fcc7dd1cc5 outdated

  19 | -* Write release notes (see below).
  20 | -* Update `src/chainparams.cpp` nMinimumChainWork with information from the getblockchaininfo rpc.
  21 | -* Update `src/chainparams.cpp` defaultAssumeValid with information from the getblockhash rpc.
  22 | +### Before every major and minor release
  23 | +
  24 | +- Update [bips.md](bips.md) to account for changes since the last release.

MarcoFalke commented at 4:51 PM on May 10, 2019:

Could you please keep the previous formatting of * to minimize the diff and make review easier?

jonatack commented at 5:18 PM on May 10, 2019:

Done.

MarcoFalke commented at 5:57 PM on May 10, 2019: member

ACK

MarcoFalke commented at 5:57 PM on May 10, 2019: member

Please squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits

[docs] Update release-process.md

- Create a release notes draft wiki for collaborative editing at https://github.com/bitcoin-core/bitcoin-devwiki/wiki as seen for releases 0.17.0 and 0.18.0.

- As per http://www.erisian.com.au/bitcoin-core-dev/log-2019-03-28.html#l-342, for the period during which the notes are being edited on the wiki, the version on the branch should be wiped and replaced with a link to the wiki which should be used for all announcements until final.

- Before final, remove the "Needs release note" label from relevant PRs/issues and merge the release notes from the wiki into the branch.

- Create a pinned meta-issue dedicated to testing the release candidate and communicate it in release announcements where useful. The former is done in practice (e.g. #15555, #14902) and the latter addresses the discussion here: https://x0f.org/web/statuses/101753569204220416.

- Adapt and merge the updates in https://github.com/bitcoin/bitcoin/pull/15692.

- Update the version numbers in all the examples.

- Reorganise the headers in the Branch Updates section.

96d32a7bc0

[docs] Update release-notes.md

- Write an introduction explaining how to use the release-notes.md template.

- Adapt and merge the updates in https://github.com/bitcoin/bitcoin/pull/15692.

bd63c1ed12

jonatack force-pushed on May 10, 2019

jonatack commented at 6:57 PM on May 10, 2019: member

Squashed down to 2 logical commits with updated commit messages, and updated the PR description.

MarcoFalke merged this on May 10, 2019

MarcoFalke closed this on May 10, 2019

MarcoFalke referenced this in commit e79bbb73e0 on May 10, 2019

jonatack deleted the branch on May 10, 2019

Munkybooty referenced this in commit 871dbb90ad on Oct 16, 2021

Munkybooty referenced this in commit b138ac49b2 on Oct 16, 2021

DrahtBot locked this on Dec 16, 2021