Skip to content

reformat release docs #6075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 13, 2022
Merged

reformat release docs #6075

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions website/content/en/docs/contribution-guidelines/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,16 +71,9 @@ We will use the `v1.3.0` release version in this example.
git push -u upstream v1.3.x
```
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.
1. Create and merge a commit that updates the top-level [Makefile] variable `IMAGE_VERSION`
to the upcoming release tag `v1.3.0`. This variable ensures sample projects have been tagged
correctly prior to the release commit.
```sh
sed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.0/g' Makefile
```
For MAC users command will be little different.
```sh
gsed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.0/g' Makefile
```

### 0. Lock the `master` branch

1. Lock down the `master` branch to prevent further commits before the release completes:
1. Go to `Settings -> Branches` in the SDK repo.
1. Under `Branch protection rules`, click `Edit` on the `master` branch rule.
Expand All @@ -97,6 +90,16 @@ git pull
git checkout -b release-$RELEASE_VERSION
```

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

```sh
Expand Down