Skip to content

[Docs] Release process updates #15607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
maflcko merged 2 commits into from
May 10, 2019
Merged

[Docs] Release process updates #15607

maflcko merged 2 commits into from
May 10, 2019

Conversation

@jonatack
Copy link
Member

@jonatack jonatack commented Mar 15, 2019 •
edited
Loading

Updates to release-notes.md:

Updates to release-process.md:

@fanquake fanquake added the Docs label Mar 15, 2019
maflcko
maflcko reviewed Mar 15, 2019
View reviewed changes
@jonatack jonatack changed the title Release process updates [Docs] Release process updates Mar 15, 2019
fanquake
fanquake reviewed Mar 16, 2019
View reviewed changes
@fanquake
Copy link
Member

fanquake commented Mar 16, 2019

utACK. Please squash your changes.

@jonatack jonatack force-pushed the release-process-updates branch from 310080b to ff41428 Compare March 16, 2019 12:52
@jonatack
Copy link
Member Author

jonatack commented Mar 16, 2019

Updated and squashed. Thanks for reviewing 👍

@fanquake
Copy link
Member

fanquake commented Mar 17, 2019 •
edited
Loading

utACK ff41428

laanwj
laanwj reviewed Mar 20, 2019
View reviewed changes
@fanquake
Copy link
Member

fanquake commented Mar 20, 2019

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

@jonatack jonatack force-pushed the release-process-updates branch 4 times, most recently from 1874a21 to 7ac4209 Compare March 22, 2019 12:25
@jonatack
Copy link
Member Author

jonatack commented Mar 22, 2019 •
edited
Loading

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 jonatack closed this Mar 22, 2019
@jonatack jonatack reopened this Mar 22, 2019
@jonatack
Copy link
Member Author

jonatack commented Mar 22, 2019

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 jonatack force-pushed the release-process-updates branch from 7ac4209 to b9bdfe3 Compare March 28, 2019 22:11
@jonatack
Copy link
Member Author

jonatack commented Mar 28, 2019

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

@fanquake fanquake mentioned this pull request Mar 28, 2019
Closed
maflcko
maflcko reviewed Mar 28, 2019
View reviewed changes
@jonatack jonatack force-pushed the release-process-updates branch from b9bdfe3 to dba0fbb Compare March 29, 2019 12:40
@DrahtBot
Copy link
Contributor

DrahtBot commented Mar 29, 2019 •
edited
Loading

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

Conflicts

No conflicts as of last run.

maflcko
maflcko reviewed Apr 15, 2019
View reviewed changes
@jonatack jonatack force-pushed the release-process-updates branch 5 times, most recently from a68cbce to 06d2835 Compare April 16, 2019 09:03
@jonatack jonatack force-pushed the release-process-updates branch 4 times, most recently from 3fd0cf3 to 80ad32c Compare April 16, 2019 09:26
@jonatack jonatack mentioned this pull request Apr 16, 2019
Merged
@maflcko maflcko mentioned this pull request Apr 26, 2019
Merged
@jonatack jonatack force-pushed the release-process-updates branch from 80ad32c to df17344 Compare May 1, 2019 10:43
@jonatack
Copy link
Member Author

jonatack commented May 1, 2019

rebased

maflcko
maflcko reviewed May 1, 2019
View reviewed changes
maflcko
maflcko reviewed May 1, 2019
View reviewed changes
maflcko
maflcko reviewed May 1, 2019
View reviewed changes
@maflcko
Copy link
Member

maflcko commented May 1, 2019

ACK beside nits. Thanks for sticking with this

@jonatack jonatack force-pushed the release-process-updates branch from df17344 to 7d9af39 Compare May 10, 2019 15:08
jonatack
jonatack commented May 10, 2019
View reviewed changes
doc/release-process.md Outdated
Copy link
Member Author

@jonatack jonatack May 10, 2019

Choose a reason for hiding this comment

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

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

jonatack commented May 10, 2019

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

maflcko
maflcko reviewed May 10, 2019
View reviewed changes
@maflcko
Copy link
Member

maflcko commented May 10, 2019

ACK

@maflcko
Copy link
Member

maflcko commented May 10, 2019

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

jonatack added 2 commits May 10, 2019 20:35
@jonatack
[docs] Update release-process.md
96d32a7 
- 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. bitcoin#15555, bitcoin#14902) and the latter addresses the discussion here: https://x0f.org/web/statuses/101753569204220416.

- Adapt and merge the updates in bitcoin#15692.

- Update the version numbers in all the examples.

- Reorganise the headers in the Branch Updates section.
@jonatack
[docs] Update release-notes.md
bd63c1e 
- Write an introduction explaining how to use the release-notes.md template.

- Adapt and merge the updates in bitcoin#15692.
@jonatack jonatack force-pushed the release-process-updates branch from 4d53bbc to bd63c1e Compare May 10, 2019 18:39
@jonatack
Copy link
Member Author

jonatack commented May 10, 2019

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

@maflcko maflcko merged commit bd63c1e into bitcoin:master May 10, 2019
maflcko pushed a commit that referenced this pull request May 10, 2019
Merge #15607: [Docs] Release process updates
e79bbb7 
bd63c1e [docs] Update release-notes.md (Jon Atack)
96d32a7 [docs] Update release-process.md (Jon Atack)

Pull request description:

  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.

ACKs for commit bd63c1:

Tree-SHA512: a436d6d0971bf00f081d4e2660c3b37a0f96913236c33934453387d63c11556a80e428b110f5629f07a6aa98e627f86c799d10c3f40e9f0c27b22275e04f6fa8
@jonatack jonatack deleted the release-process-updates branch May 10, 2019 20:49
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Dec 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@laanwj laanwj laanwj left review comments

@fanquake fanquake fanquake left review comments

+1 more reviewer

@maflcko maflcko maflcko left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@jonatack @fanquake @DrahtBot @maflcko @laanwj