Skip to content
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

Add the release runbook to RELEASING.md #2533

Merged
merged 5 commits into from
Nov 10, 2022
Merged

Add the release runbook to RELEASING.md #2533

merged 5 commits into from
Nov 10, 2022

Conversation

noCharger
Copy link
Contributor

@noCharger noCharger commented Oct 7, 2022 •
edited
Loading

Signed-off-by: Louis Chu lingzhichu.clz@gmail.com

Description

Add release runbook

Check List

  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

@noCharger noCharger changed the title Add release runbook Add release runbook on RELEASING.md Oct 7, 2022
@noCharger noCharger force-pushed the release-runbook branch 2 times, most recently from c4433a4 to 28af853 Compare October 7, 2022 16:24
@noCharger noCharger marked this pull request as ready for review October 7, 2022 16:25
@noCharger noCharger requested a review from a team as a code owner October 7, 2022 16:25
@seanneumann
Copy link
Contributor

Thanks @noCharger. We'll take some time to review this. Really appreciate this contribution.

kavilla
kavilla reviewed Oct 11, 2022
View reviewed changes
RELEASING.md Outdated Show resolved Hide resolved
kavilla
kavilla reviewed Oct 11, 2022
View reviewed changes
Copy link
Member

@kavilla kavilla left a comment

Choose a reason for hiding this comment

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

Awesome! Thank you so much @noCharger !

RELEASING.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
RELEASING.md Show resolved Hide resolved
@noCharger
Copy link
Contributor Author

Thanks team for the great feedbacks! I'll revise it and get back to you.

joshuarrrr
joshuarrrr previously approved these changes Oct 19, 2022
View reviewed changes
Copy link
Member

@joshuarrrr joshuarrrr left a comment •
edited
Loading

Choose a reason for hiding this comment

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

@noCharger Thanks so much for putting this together, it's super valuable.

One thing to consider is how the RM will use this document in concert with the release issue checklist - I could imagine that we update the template so that some of the checklist items link to some of these section headers.

The only major thing this doc is missing is a section about validating that merged commits have been properly backported - that turned out to be a major pain on the last patch release I handled, because the backport automation had failed on the majority of PRs merged and labeled.

A couple minor wording and formatting suggestions.

(Approval assumes feedback from other reviewers will be addressed.)

RELEASING.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
@seraphjiang seraphjiang added the docs Improvements or additions to documentation label Oct 25, 2022
@noCharger
Copy link
Contributor Author

One thing to consider is how the RM will use this document in concert with the release issue checklist - I could imagine that we update the template so that some of the checklist items link to some of these section headers.

Good suggestion! Since I can't seem to find a release template, we should make one and automate release issue generation.

@noCharger noCharger requested review from kavilla, joshuarrrr and a team October 31, 2022 16:51
@seanneumann seanneumann mentioned this pull request Nov 7, 2022
Closed
seanneumann
seanneumann previously approved these changes Nov 7, 2022
View reviewed changes
Copy link
Contributor

@seanneumann seanneumann left a comment

Choose a reason for hiding this comment

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

Thanks @noCharger! This is great. Thanks for the updates to feedback. Let's get this merged and make sure next RM updates it right after release. In this case, @ananzh and @AMoo-Miki should update any necessary changes after 2.4 goes out the door.

Approving.

AMoo-Miki
AMoo-Miki requested changes Nov 8, 2022
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
noCharger and others added 3 commits November 7, 2022 21:11
@noCharger
Add release runbook on RELEASING.md
ee7f839 
Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
@noCharger
Update wording based on comments
76b6fed 
Signed-off-by: Louis Chu <clingzhi@amazon.com>
@noCharger
Update wording based on comment
4ce32f7 
Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
@noCharger noCharger force-pushed the release-runbook branch 2 times, most recently from 0b81faf to df565bf Compare November 8, 2022 05:16
@AMoo-Miki AMoo-Miki changed the title Add release runbook on RELEASING.md Add the release runbook to RELEASING.md Nov 10, 2022
@noCharger
Resolve CHANGELOG.MD conflicts
bb5fecd 
Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
@noCharger noCharger dismissed stale reviews from ananzh and AMoo-Miki via bb5fecd November 10, 2022 19:38
@ananzh ananzh merged commit d53fbf8 into opensearch-project:main Nov 10, 2022
@ananzh ananzh added v2.5.0 'Issues and PRs related to version v2.5.0' backport 2.x labels Nov 10, 2022
@ananzh
Copy link
Member

ananzh commented Nov 10, 2022

Since we are gonna release 2.5 and people might need to understand this release process, I add backport 2.x tag and mark it as v2.5.0

Thanks @noCharger for this nice document.

@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Nov 10, 2022
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 10, 2022
@github-actions
Add the release runbook to RELEASING.md (#2533)
ede1ad7 
* Add release runbook on RELEASING.md

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Update wording based on comments

Signed-off-by: Louis Chu <clingzhi@amazon.com>

* Update wording based on comment

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Resolve CHANGELOG.MD conflicts

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
Signed-off-by: Louis Chu <clingzhi@amazon.com>
(cherry picked from commit d53fbf8)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md
zhongnansu pushed a commit that referenced this pull request Nov 16, 2022
@opensearch-trigger-bot @github-actions
Add the release runbook to RELEASING.md (#2533) (#2854)
2cfea76 
* Add release runbook on RELEASING.md

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
(cherry picked from commit d53fbf8)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Nov 28, 2022
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 28, 2022
@github-actions
Add the release runbook to RELEASING.md (#2533)
12afe0d 
* Add release runbook on RELEASING.md

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Update wording based on comments

Signed-off-by: Louis Chu <clingzhi@amazon.com>

* Update wording based on comment

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Resolve CHANGELOG.MD conflicts

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
Signed-off-by: Louis Chu <clingzhi@amazon.com>
(cherry picked from commit d53fbf8)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md
joshuarrrr added a commit that referenced this pull request Nov 29, 2022
@opensearch-trigger-bot @github-actions @joshuarrrr
[Backport 1.x] Add the release runbook to RELEASING.md (#2933)
4be3682 
* Add the release runbook to RELEASING.md (#2533)

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

(cherry picked from commit d53fbf8)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md

* [Chore] Add changelog

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
opensearch-trigger-bot bot added a commit that referenced this pull request Nov 29, 2022
@opensearch-trigger-bot @github-actions
[Backport 1.x] Add the release runbook to RELEASING.md (#2933)
f8f53af 
* Add the release runbook to RELEASING.md (#2533)

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

(cherry picked from commit d53fbf8)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md

* [Chore] Add changelog

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 4be3682)
joshuarrrr pushed a commit that referenced this pull request Nov 29, 2022
@opensearch-trigger-bot
[Backport 1.x] Add the release runbook to RELEASING.md (#2933) (#2945)
1d8ee62 
* Add the release runbook to RELEASING.md (#2533)

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

(cherry picked from commit d53fbf8)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md

* [Chore] Add changelog

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 4be3682)

Co-authored-by: opensearch-trigger-bot[bot] <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com>
AlexRuiz7 pushed a commit to wazuh/wazuh-dashboard that referenced this pull request Dec 14, 2022
@noCharger @AlexRuiz7
Add the release runbook to RELEASING.md (opensearch-project#2533)
a8d9401 
* Add release runbook on RELEASING.md

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Update wording based on comments

Signed-off-by: Louis Chu <clingzhi@amazon.com>

* Update wording based on comment

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Resolve CHANGELOG.MD conflicts

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
Signed-off-by: Louis Chu <clingzhi@amazon.com>
AlexRuiz7 pushed a commit to wazuh/wazuh-dashboard that referenced this pull request Dec 14, 2022
@noCharger @AlexRuiz7
Add the release runbook to RELEASING.md (opensearch-project#2533)
eb41146 
* Add release runbook on RELEASING.md

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Update wording based on comments

Signed-off-by: Louis Chu <clingzhi@amazon.com>

* Update wording based on comment

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Resolve CHANGELOG.MD conflicts

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
Signed-off-by: Louis Chu <clingzhi@amazon.com>
sipopo pushed a commit to sipopo/OpenSearch-Dashboards that referenced this pull request Dec 16, 2022
@noCharger @sipopo
Add the release runbook to RELEASING.md (opensearch-project#2533)
09edbdc 
* Add release runbook on RELEASING.md

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Update wording based on comments

Signed-off-by: Louis Chu <clingzhi@amazon.com>

* Update wording based on comment

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Resolve CHANGELOG.MD conflicts

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
Signed-off-by: Louis Chu <clingzhi@amazon.com>
Signed-off-by: Sergey Osipov <sipopo@yandex.ru>
Arpit-Bandejiya pushed a commit to Arpit-Bandejiya/OpenSearch-Dashboards that referenced this pull request Jan 13, 2023
@noCharger @Arpit-Bandejiya
Add the release runbook to RELEASING.md (opensearch-project#2533)
1185e72 
* Add release runbook on RELEASING.md

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Update wording based on comments

Signed-off-by: Louis Chu <clingzhi@amazon.com>

* Update wording based on comment

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Resolve CHANGELOG.MD conflicts

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
Signed-off-by: Louis Chu <clingzhi@amazon.com>
Signed-off-by: Arpit Bandejiya <abandeji@amazon.com>
sikhote pushed a commit to sikhote/OpenSearch-Dashboards that referenced this pull request Apr 24, 2023
@noCharger @sikhote
Add the release runbook to RELEASING.md (opensearch-project#2533)
2dcc140 
* Add release runbook on RELEASING.md

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Update wording based on comments

Signed-off-by: Louis Chu <clingzhi@amazon.com>

* Update wording based on comment

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Resolve CHANGELOG.MD conflicts

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
Signed-off-by: Louis Chu <clingzhi@amazon.com>
Signed-off-by: David Sinclair <david@sinclair.tech>
sikhote pushed a commit to sikhote/OpenSearch-Dashboards that referenced this pull request Apr 24, 2023
@noCharger @sikhote
Add the release runbook to RELEASING.md (opensearch-project#2533)
8820a16 
* Add release runbook on RELEASING.md

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Update wording based on comments

Signed-off-by: Louis Chu <clingzhi@amazon.com>

* Update wording based on comment

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

* Resolve CHANGELOG.MD conflicts

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>

Signed-off-by: Louis Chu <lingzhichu.clz@gmail.com>
Signed-off-by: Louis Chu <clingzhi@amazon.com>
Signed-off-by: David Sinclair <david@sinclair.tech>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AMoo-Miki AMoo-Miki AMoo-Miki approved these changes

@ananzh ananzh ananzh approved these changes

@kavilla kavilla Awaiting requested review from kavilla kavilla is a code owner

@joshuarrrr joshuarrrr Awaiting requested review from joshuarrrr joshuarrrr is a code owner

@seanneumann seanneumann Awaiting requested review from seanneumann

Assignees
No one assigned
Labels
backport 2.x docs Improvements or additions to documentation v1.3.7 v2.5.0 'Issues and PRs related to version v2.5.0'
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@noCharger @seanneumann @ananzh @joshuarrrr @AMoo-Miki @kavilla @seraphjiang