Update the release process documentation for latest changes.#6986
Merged
dlvenable merged 2 commits intoJul 6, 2026
Conversation
We have made a number of significant changes to the release process. Some of these come from changes in the OpenSearch project and some are from additional automation we have added. This includes updates for how we coordinate with other parts of the OpenSearch project, steps that require the OpenSearch project to create branches and tags, and updates based on automation. I've also added additional information about releasing blog posts and updating the community. Signed-off-by: David Venable <dlv@amazon.com>
dlvenable
requested review from
KarstenSchnitter,
Zhangxunmt,
dinujoh,
divbok,
graytaylor0,
kkondaka,
oeyh,
san81,
sb2k16,
srikanthjg and
srikanthpadakanti
as code owners
July 6, 2026 15:10
srikanthpadakanti
approved these changes
Jul 6, 2026
srikanthpadakanti
left a comment
srikanthpadakanti
left a comment
Collaborator
There was a problem hiding this comment.
Added few nit comments.
| @@ -40,6 +81,8 @@ Steps: | |||
| 2. Select `New label` | |||
| 3. Name the branch `backport {major}.minor`. For example, `backport 2.6` | |||
Collaborator
There was a problem hiding this comment.
Nit: missing braces, should be backport {major}.{minor}.
| - [ ] Run the [Release Artifacts workflow](https://github.com/opensearch-project/data-prepper/actions/workflows/release.yml) | ||
| - [ ] Approve the release issue (requires 2 maintainer approvals) | ||
| - [ ] Update the draft release with release notes | ||
| - [ ] Update the pre-release with release notes |
Collaborator
There was a problem hiding this comment.
Consider clarifying: "click 'Set as latest release' on the pre-release page" since there is no "latest" label in the GitHub UI
| * Find the new pre-release. It should be at the top. | ||
| * Replace the auto-generated release notes with the release notes created previous to the release. | ||
| * Release it | ||
| * Change the label from pre-release to latest. |
Collaborator
There was a problem hiding this comment.
Same nit here: this is the "Set as latest release" button, not a label. New maintainers will look for a label field that does not exist.
|
|
||
| If you are creating a new major/minor release, then you will need to create the release branch. | ||
| Use GitHub to create a new branch. | ||
| The OpenSearch project restricts branch creation, so you must request the branch by creating a [GitHub Request](https://github.com/opensearch-project/.github/issues/new?template=GITHUB_REQUEST_TEMPLATE.yaml). |
Collaborator
There was a problem hiding this comment.
Suggest adding an expectation like "these requests typically take 1 to 2 business days" or a realistic eta
Signed-off-by: David Venable <dlv@amazon.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
We have made a number of significant changes to the release process. Some of these come from changes in the OpenSearch project and some are from additional automation we have added. This includes updates for how we coordinate with other parts of the OpenSearch project, steps that require the OpenSearch project to create branches and tags, and updates based on automation. I've also added additional information about releasing blog posts and updating the community.
Issues Resolved
N/A
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.