Skip to content

Commit 608bbfa

Browse files
committed
doc/design,Makefile: Remove references to root manifest directory
Signed-off-by: timflannagan <[email protected]>
1 parent 3334fd0 commit 608bbfa

File tree

2 files changed

+21
-31
lines changed

2 files changed

+21
-31
lines changed

Makefile

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -224,12 +224,6 @@ release: manifests
224224
docker pull quay.io/operator-framework/olm:v$(ver)
225225
$(MAKE) target=upstream ver=$(ver) quickstart=true package
226226
$(MAKE) target=ocp ver=$(ver) package
227-
rm -rf manifests
228-
mkdir manifests
229-
cp -R deploy/ocp/manifests/$(ver)/. manifests
230-
# requires gnu sed if on mac
231-
find ./manifests -type f -exec sed -i "/^#/d" {} \;
232-
find ./manifests -type f -exec sed -i "1{/---/d}" {} \;
233227

234228
verify-release: release diff
235229

doc/design/release.md

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

33
## 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.
54

5+
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.
66

77
## Step 1: Installing Requirements
8-
Ensure you have `autoconf`, `automake`, and `libtool` installed. On Fedora, you can run
98

10-
```
9+
Ensure you have `autoconf`, `automake`, and `libtool` installed.
10+
11+
The following command can be used to install these packages on Fedora:
12+
13+
```bash
1114
dnf install autoconf automake libtool
1215
```
1316

14-
1517
## Step 2: Verify Manifests
16-
We need to ensure that `./manifests` folder is in sync with the templates in `deploy/chart/templates`.
18+
1719
* Make sure you have a clean workspace. `git status` should show no change(s) or untracked file.
1820
* Make sure you pull the latest from `upstream`.
1921
* Checkout `master` branch.
2022
* Run `make release`
2123

22-
This should generate no change(s) in `./manifests` folder. If there are no change(s) in `./manifests` folder then you can proceed with the new release.
23-
You can clean your workspace
24-
```bash
25-
git checkout -- .
26-
git clean -df
27-
```
28-
29-
If you see change(s) in `./manifests` folder, then:
30-
* STOP the release process
31-
* Consult the team and backport the changes in `./manifests` folder into the templates.
32-
33-
3424
## Step 3: Bump the Version
25+
3526
* Bump the version in `OLM_VERSION` file. Make a new PR with this change only.
3627
* Wait until the PR has been merged.
3728

38-
3929
## Step 4: Setup Tag
30+
4031
If git `push` is disabled on `upstream` repository in your fork, then clone this repository so that you can push to `master` directly.
4132

4233
* Pull the latest.
4334
* Make sure you are on `master` branch.
44-
* Make a new tag that matches the version.
35+
* Make a new tag that matches the version.
4536
* Push tag directly to this repository.
4637

4738
```bash
@@ -55,26 +46,29 @@ git push origin 0.11.0
5546
* Confirm that new images have been built here: <https://quay.io/repository/operator-framework/olm?tab=builds>.
5647

5748
## Step 5: Generate Manifests
49+
5850
* Make sure you have a clean workspace. `git status` should show no change(s) or untracked file.
5951
* Make sure you pull the latest from `upstream`.
6052
* Run `make release` on `master` branch.
6153
* Make a new PR and ensure all tests pass for merging.
6254

6355
Verify the following:
56+
6457
* The image digest in manifest file(s) matches the new tag in `quay.io`.
65-
* `./manifests` folder only differs in version and image.
6658

6759
## Step 6: Generate Changelog
60+
6861
Changelogs for OLM are generated using [GitHub Changelog Generator](https://github.com/github-changelog-generator/github-changelog-generator).
6962

7063
You need to have `gem` installed on your workstation. Execute the following command to install `github-changelog-generator`.
64+
7165
```bash
7266
gem install github_changelog_generator
73-
```
67+
```
7468

7569
Afterward installing it may be worth modifying the `MAX_THREAD_NUMBER` to something lower similar to what is done here: <https://github.com/github-changelog-generator/github-changelog-generator/pull/661>. Note that the referenced PR has been merged, but the number is still too high. Although 1 is a very low value, it does seem to work more reliably. (On Fedora, the install location for the gem is `~/.gem/ruby/gems/github_changelog_generator-1.14.3/lib/github_changelog_generator/octo_fetcher.rb`.)
7670

77-
Make sure you have a GitHub API access token. You can generate one from [tokens](https://github.com/settings/tokens)
71+
Make sure you have a GitHub API access token. You can generate one from [tokens](https://github.com/settings/tokens)
7872

7973
* Generate the changelog:
8074
```bash
@@ -86,19 +80,21 @@ github_changelog_generator -u operator-framework -p operator-lifecycle-manager -
8680
* Open a new PR with the changelog.
8781

8882
## Step 7: Create a New GitHub Release
83+
8984
* Create a new GtiHub release [here](https://github.com/operator-framework/operator-lifecycle-manager/releases/new)
9085
* Choose the new tag matching the version you created.
9186
* You can set `Title` to the same value as the tag name.
9287
* Add the generated `changelog` to the release description.
9388
* Save `draft` of the release.
9489

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

101-
10297
## Step 9: Publish Release
98+
10399
* Ensure that all links are valid and works as expected.
104-
* Publish the release!
100+
* Publish the release!

0 commit comments

Comments
 (0)