Skip to content

Commit b981133

Browse files
committed
(docs) Update release.md documentation
OLM contains multiple folders named manifests. This commit introduces a change which makes it clear which manifests folder is being referred to.
1 parent 1c37172 commit b981133

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/design/release.md

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

33
## Step 1: Verify Manifests
4-
We need to ensure that `manifests` folder is in sync with the templates in `deploy/chart/templates`.
4+
We need to ensure that `./manifests` folder is in sync with the templates in `deploy/chart/templates`.
55
* Make sure you have a clean workspace. `git status` should show no change(s) or untracked file.
66
* Make sure you pull the latest from `upstream`.
77
* Checkout `master` branch.
88
* Run `make release`
99

10-
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.
10+
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.
1111
You can clean your workspace
1212
```bash
1313
git checkout -- .
1414
git clean -df
1515
```
1616

17-
If you see change(s) in `manifests` folder, then:
17+
If you see change(s) in `./manifests` folder, then:
1818
* STOP the release process
19-
* Consult the team and backport the changes in `manifests` folder into the templates.
19+
* Consult the team and backport the changes in `./manifests` folder into the templates.
2020

2121

2222
## Step 2: Bump the Version
@@ -51,7 +51,7 @@ git push origin 0.11.0
5151

5252
Verify the following:
5353
* The image digest in manifest file(s) matches the new tag in `quay.io`.
54-
* `manifests` folder only differs in version and image.
54+
* `./manifests` folder only differs in version and image.
5555

5656
## Step 4: Generate Changelog
5757
Changelogs for OLM are generated using [GitHub Changelog Generator](https://github.com/github-changelog-generator/github-changelog-generator).

0 commit comments

Comments
 (0)