Skip to content

Commit 240be20

Browse files
authored
reformat release docs (#6075)
Signed-off-by: Jonathan Berkhahn <[email protected]> Signed-off-by: Jonathan Berkhahn <[email protected]>
1 parent ead5efa commit 240be20

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

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

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,9 @@ We will use the `v1.3.0` release version in this example.
7171
git push -u upstream v1.3.x
7272
```
7373
1. Make sure that the list of supported OLM versions stated in the [Overview][overview] section of SDK docs is updated. If a new version of OLM needs to be officially supported, follow the steps in [updating OLM bindata](#updating-olm-bindata) section.
74-
1. Create and merge a commit that updates the top-level [Makefile] variable `IMAGE_VERSION`
75-
to the upcoming release tag `v1.3.0`. This variable ensures sample projects have been tagged
76-
correctly prior to the release commit.
77-
```sh
78-
sed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.0/g' Makefile
79-
```
80-
For MAC users command will be little different.
81-
```sh
82-
gsed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.0/g' Makefile
83-
```
74+
75+
### 0. Lock the `master` branch
76+
8477
1. Lock down the `master` branch to prevent further commits before the release completes:
8578
1. Go to `Settings -> Branches` in the SDK repo.
8679
1. Under `Branch protection rules`, click `Edit` on the `master` branch rule.
@@ -97,6 +90,16 @@ git pull
9790
git checkout -b release-$RELEASE_VERSION
9891
```
9992

93+
Update the top-level [Makefile] variable `IMAGE_VERSION`
94+
to the upcoming release tag `v1.3.0`. This variable ensures sample projects have been tagged
95+
correctly prior to the release commit.
96+
```sh
97+
sed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.0/g' Makefile
98+
```
99+
For MAC users command will be little different.
100+
```sh
101+
gsed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.0/g' Makefile
102+
```
100103
Run the pre-release `make` target:
101104

102105
```sh

0 commit comments

Comments
 (0)