Skip to content

Commit ae60385

Browse files
committed
Update release.md with milestone step
1 parent 5eb1fa6 commit ae60385

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

doc/design/release.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
# Steps to create a new release
22

3-
## Step 0: Installing Requirements
3+
## Step 0: Review the Release Milestone
4+
If the release you plan to create corresponds with an existing [milestone](https://github.com/operator-framework/operator-lifecycle-manager/milestone/), make sure that all features have been committed. If a feature will not be added to the release be sure to remove it from the milestone.
45

6+
7+
## Step 1: Installing Requirements
58
Ensure you have `autoconf`, `automake`, and `libtool` installed. On Fedora, you can run
69

710
```
811
dnf install autoconf automake libtool
912
```
1013

11-
## Step 1: Verify Manifests
14+
15+
## Step 2: Verify Manifests
1216
We need to ensure that `./manifests` folder is in sync with the templates in `deploy/chart/templates`.
1317
* Make sure you have a clean workspace. `git status` should show no change(s) or untracked file.
1418
* Make sure you pull the latest from `upstream`.
@@ -27,12 +31,12 @@ If you see change(s) in `./manifests` folder, then:
2731
* Consult the team and backport the changes in `./manifests` folder into the templates.
2832

2933

30-
## Step 2: Bump the Version
34+
## Step 3: Bump the Version
3135
* Bump the version in `OLM_VERSION` file. Make a new PR with this change only.
3236
* Wait until the PR has been merged.
3337

3438

35-
## Step 3: Setup Tag
39+
## Step 4: Setup Tag
3640
If git `push` is disabled on `upstream` repository in your fork, then clone this repository so that you can push to `master` directly.
3741

3842
* Pull the latest.
@@ -50,8 +54,7 @@ git push origin 0.11.0
5054

5155
* Confirm that new images have been built here: <https://quay.io/repository/operator-framework/olm?tab=builds>.
5256

53-
54-
## Step 3: Generate Manifests
57+
## Step 5: Generate Manifests
5558
* Make sure you have a clean workspace. `git status` should show no change(s) or untracked file.
5659
* Make sure you pull the latest from `upstream`.
5760
* Run `make release` on `master` branch.
@@ -61,7 +64,7 @@ Verify the following:
6164
* The image digest in manifest file(s) matches the new tag in `quay.io`.
6265
* `./manifests` folder only differs in version and image.
6366

64-
## Step 4: Generate Changelog
67+
## Step 6: Generate Changelog
6568
Changelogs for OLM are generated using [GitHub Changelog Generator](https://github.com/github-changelog-generator/github-changelog-generator).
6669

6770
You need to have `gem` installed on your workstation. Execute the following command to install `github-changelog-generator`.
@@ -82,20 +85,20 @@ github_changelog_generator -u operator-framework -p operator-lifecycle-manager -
8285
```
8386
* Open a new PR with the changelog.
8487

85-
## Step 5: Create a New GitHub Release
88+
## Step 7: Create a New GitHub Release
8689
* Create a new GtiHub release [here](https://github.com/operator-framework/operator-lifecycle-manager/releases/new)
8790
* Choose the new tag matching the version you created.
8891
* You can set `Title` to the same value as the tag name.
8992
* Add the generated `changelog` to the release description.
9093
* Save `draft` of the release.
9194

9295

93-
## Step 5: QuickStart
96+
## Step 8: QuickStart
9497
Edit the GitHub Release:
9598
* Upload the files `crds.yam`, `install.sh` and `olm.yaml` as release artifacts. These files are located in `deploy/upstream/quickstart`
9699
* Add install instruction, see an [example here](https://github.com/operator-framework/operator-lifecycle-manager/releases/tag/0.10.0#Install).
97100

98101

99-
## Step 6: Publish Release
102+
## Step 9: Publish Release
100103
* Ensure that all links are valid and works as expected.
101-
* Publish the release!
104+
* Publish the release!

0 commit comments

Comments
 (0)