Skip to content

Commit 620a669

Browse files
authored
Update release guide with more details (opensearch-project#651)
Signed-off-by: Ian Hoang <ianhoang16@gmail.com>
1 parent 376d370 commit 620a669

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

RELEASE_GUIDE.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Releases are tagged with labels in the scheme `vN.N.N`, for instance `v1.0.0`, `
3535
The release process is standard across repositories in this open-source project and is run by a release manager volunteering from amongst the [maintainers](MAINTAINERS.md).
3636

3737
## Backport PRs
38-
Add backport labels to PRs and commits so that changes can be added to `main` branch and other related major and minor version branches. For example, if a PR is published as a patch fix for OSB version 1.3.0, it should be labeled with a backport label called `backport-1.3` so that it backports to `1.3` branch.
38+
Add backport labels to PRs and commits so that changes can be added to `main` branch and other related major and minor version branches. For example, if a PR is published as a patch fix for OSB version 1.3.0, it should be labeled with a backport label called `backport-1.3` so that it backports to `1.3` branch.
3939

4040
## Prerequisites
4141

@@ -55,7 +55,7 @@ NOTE: The version number below is in semantic format, for instance, `1.2.0`.
5555

5656
1. Create a tag: `git tag <VERSION> main`
5757
1. Ensure that this is done in the main official opensearch-benchmark repository
58-
2. This should be the new version that matches the version in version.txt.
58+
2. This should be the `<VERSION>` tag that matches the entry in version.txt.
5959
3. For patch releases: Change `main` to the major and minor version branch name
6060

6161
2. Push the tag: `git push origin <VERSION>`
@@ -119,11 +119,23 @@ Send this message in the following channels in OpenSearch Community Slack:
119119

120120
## Error Handling
121121

122+
### Remove a tag
123+
122124
If error occurs during build process and need to retrigger the workflow, do the following:
123125

124-
* Delete the tag locally `git tag -d <VERSION>`
126+
* Delete the tag locally `git tag -d <VERSION>` and `git push --delete origin <VERSION>` to remove in remote repository
125127
* Delete the tag on Github
126128
* Delete draft-release on Github
127129

128130
Then, create the tag again and push it.
129131

132+
133+
### Rename a tag
134+
135+
If you published an incorrect tag name, then follow these steps:
136+
137+
1. Run `git tag new_tag_name old_tag_name` to move old tag references to new tag alias
138+
2. Run `git tag -d old_tag_name` to delete old tag locally
139+
3. Ensure your remote is correct with `git remote -v`. Run `git push origin :refs/tags/old_tag_name` to remove old tag references in remote repository
140+
4. Run `git push origin --tags` to make remote tags look like local tags
141+
5. Verify that the release draft is pointing to the new tag

0 commit comments

Comments
 (0)