Skip to content

Commit f001180

Browse files
Merge pull request #916 from jpeeler/release-docs-2
docs(release): add additional clarifying details
2 parents 448ed54 + ebed829 commit f001180

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Documentation/design/release.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,16 @@
1212

1313
Changelogs for OLM are generated using [GitHub Changelog Generator](https://github.com/github-changelog-generator/github-changelog-generator).
1414

15-
If the gem command is available, one can install via `gem install github_changelog_generator`. 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>. Now the changelog can be generated:
15+
If the gem command is available, one can install via `gem install github_changelog_generator`. 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.)
16+
17+
Now the changelog can be generated:
1618

1719
```bash
1820
github_changelog_generator -u operator-framework -p operator-lifecycle-manager --since-tag=<start-semver> \
1921
--token=<github-api-token> --future-release=<end-semver> --pr-label="**Other changes:**"
2022
```
2123

22-
The resulting CHANGELOG.md file can be copied into a new release created via <https://github.com/operator-framework/operator-lifecycle-manager/releases/new>.
24+
The resulting CHANGELOG.md file can be copied into a new release created via <https://github.com/operator-framework/operator-lifecycle-manager/releases/new>. Also, make sure to commit the new changes to CHANGELOG.md as well.
2325

2426
## QuickStart
2527

0 commit comments

Comments
 (0)