You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: RELEASE_GUIDE.md
+15-3
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ Releases are tagged with labels in the scheme `vN.N.N`, for instance `v1.0.0`, `
35
35
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).
36
36
37
37
## 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.
39
39
40
40
## Prerequisites
41
41
@@ -55,7 +55,7 @@ NOTE: The version number below is in semantic format, for instance, `1.2.0`.
55
55
56
56
1. Create a tag: `git tag <VERSION> main`
57
57
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.
59
59
3. For patch releases: Change `main` to the major and minor version branch name
60
60
61
61
2. Push the tag: `git push origin <VERSION>`
@@ -119,11 +119,23 @@ Send this message in the following channels in OpenSearch Community Slack:
119
119
120
120
## Error Handling
121
121
122
+
### Remove a tag
123
+
122
124
If error occurs during build process and need to retrigger the workflow, do the following:
123
125
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
125
127
* Delete the tag on Github
126
128
* Delete draft-release on Github
127
129
128
130
Then, create the tag again and push it.
129
131
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