Update release guide with more details #651
Merged
Conversation
This file contains 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
Signed-off-by: Ian Hoang <[email protected]>
IanHoang
requested review from
gkamat,
beaioun,
cgchinmay,
rishabh6788 and
VijayanB
as code owners
gkamat
reviewed
Sep 13, 2024
There was a problem hiding this comment.
Might be good to add some material about the steps in the release process -- the github action and the webhook that are distinct, the latter triggering jenkins, and how this can be aborted by not approving the issue, in case someone needs to deal with that.
The editing of the release issue should also be added to "Error Handling" (or add a pointer back to the previous section.)
RELEASE_GUIDE.md
Outdated
| @@ -55,7 +55,7 @@ NOTE: The version number below is in semantic format, for instance, `1.2.0`. | |||
|
|
|||
| 1. Create a tag: `git tag <VERSION> main` | |||
| 1. Ensure that this is done in the main official opensearch-benchmark repository | |||
| 2. This should be the new version that matches the version in version.txt. | |||
| 2. This should be the `<VERSION>` tag matches the version in version.txt. | |||
There was a problem hiding this comment.
This should be the <VERSION> tag that matches the entry in version.txt.
Signed-off-by: Ian Hoang <[email protected]>
gkamat
approved these changes
Sep 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
After encountering a few issues in the release process, we updated the release guide.
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.