Skip to content

Commit 5c40752

Browse files
authored
doc/design: Update the changelog release documentation (#2298)
Update the doc/design/release.md documentation around how to generate the root CHANGELOG.md. Previously, when running into API rate limiting behaviors locally, the suggestion was to modify a variable in the Ruby gem package that no longer exists. Now, specify the --max-issues CLI flag to lower the number of API requests to the OLM repository. Signed-off-by: timflannagan <[email protected]>
1 parent 455975c commit 5c40752

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

doc/design/release.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,18 +66,29 @@ You need to have `gem` installed on your workstation. Execute the following comm
6666
gem install github_changelog_generator
6767
```
6868

69-
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`.)
70-
7169
Make sure you have a GitHub API access token. You can generate one from [tokens](https://github.com/settings/tokens)
7270

73-
* Generate the changelog:
71+
Run the following command to generate a changelog for this release:
72+
7473
```bash
7574
# <start-semver> is the previous version.
7675
# <end-semver> is the new release you have made.
77-
github_changelog_generator -u operator-framework -p operator-lifecycle-manager --since-tag=<start-semver> \
78-
--token=<github-api-token> --future-release=<end-semver> --pr-label="**Other changes:**" -b CHANGELOG.md
76+
GITHUB_TOKEN="<github-api-token>"
77+
github_changelog_generator \
78+
-u operator-framework \
79+
-p operator-lifecycle-manager \
80+
--token=${GITHUB_TOKEN} \
81+
--since-tag=<start-semver> \
82+
--future-release=<end-semver> \
83+
--pr-label="**Other changes:**" \
84+
-b CHANGELOG.md
7985
```
80-
* Open a new PR with the changelog.
86+
87+
**Note**: You may run into API rate limiting when attempting to generate the changelog.
88+
89+
By default, all open and closed issues will be queried when running the above command, which can lead to API rate limiting. Lower the number of issues that will be queried by specifying the `--max-issues` flag (e.g. `--max-issues=100`) and re-run the above command with that flag provided.
90+
91+
Ensure the `CHANGELOG.md` has been modified locally and open a PR with those generated changes.
8192

8293
## Step 7: Create a New GitHub Release
8394

0 commit comments

Comments
 (0)