Skip to content

Commit c7401c7

Browse files
author
Eric Stroczynski
authored
docs(release): add branch information so the correct commit is tagged (#4950)
Signed-off-by: Eric Stroczynski <[email protected]>
1 parent d3bd87c commit c7401c7

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

website/content/en/docs/contribution-guidelines/releasing.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The following changes should be present:
8181
- `website/content/en/docs/upgrading-sdk-version/v1.3.0.md`: commit changes (created by changelog generation).
8282
- `website/config.toml`: commit changes (modified by release script).
8383

84-
Commit these changes and push:
84+
Commit these changes and push to your remote (assuming your remote is named `origin`):
8585

8686
```sh
8787
git add --all
@@ -98,9 +98,14 @@ if you have admin access to the operator-sdk repo, or ask an administrator to do
9898

9999
Unlock the branch by changing the number of required approving reviewers in the `master` branch rule back to 1.
100100

101-
### 4. Create and push a release tag
101+
### 4. Create and push a release tag on `master`
102+
103+
Refresh your local `master` branch, tag the release PR commit, and push to the main operator-sdk repo
104+
(assumes the remote's name is `upstream`):
102105

103106
```sh
107+
git checkout master
108+
git pull
104109
make tag
105110
git push upstream refs/tags/$RELEASE_VERSION
106111
```
@@ -112,15 +117,15 @@ Run the following commands to do so:
112117

113118
```sh
114119
git checkout latest
115-
git reset --hard tags/$RELEASE_VERSION
120+
git reset --hard refs/tags/$RELEASE_VERSION
116121
git push -f upstream latest
117122
```
118123

119124
Similarly, to update the release branch, run:
120125

121126
```sh
122127
git checkout v1.3.x
123-
git reset --hard tags/$RELEASE_VERSION
128+
git reset --hard refs/tags/$RELEASE_VERSION
124129
git push -f upstream v1.3.x
125130
```
126131

@@ -161,12 +166,12 @@ git checkout -b release-$RELEASE_VERSION
161166
Using the version for your release as the IMAGE_VERSION, execute the
162167
following commands from the root of the project.
163168

164-
```sh
165-
# Update the IMAGE_VERSION in the Makefile
169+
```sh
170+
# Update the IMAGE_VERSION in the Makefile
166171
sed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.1/g' Makefile
167172
# Run the pre-release `make` target:
168173
make prerelease
169-
# Regenerate testdata (samples).
174+
# Regenerate testdata (samples).
170175
# NOTE: The sanity test will fail but scaffolding should complete.
171176
make test-sanity
172177
```
@@ -188,7 +193,7 @@ git push -u origin release-$RELEASE_VERSION
188193

189194
#### 3. Create and merge Pull Request
190195

191-
- Create a pull request against the `v1.3.x` branch.
196+
- Create a pull request against the `v1.3.x` branch.
192197
- Once approving review is given, merge. You may have to unlock the branch by setting
193198
"required approving reviewers" to back to `1`. (See step 0).
194199

@@ -207,7 +212,7 @@ git push upstream refs/tags/$RELEASE_VERSION
207212

208213
If the patch release is on the latest y-stream (in the example you would
209214
not ff latest if there was a y-stream for v1.4.x), you will need to
210-
fast-forward the `latest` git branch.
215+
fast-forward the `latest` git branch.
211216

212217
(The `latest` branch points to the latest release tag to keep the main website subdomain up-to-date.)
213218

0 commit comments

Comments
 (0)