You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: doc/design/release.md
+17-6Lines changed: 17 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -66,18 +66,29 @@ You need to have `gem` installed on your workstation. Execute the following comm
66
66
gem install github_changelog_generator
67
67
```
68
68
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
-
71
69
Make sure you have a GitHub API access token. You can generate one from [tokens](https://github.com/settings/tokens)
72
70
73
-
* Generate the changelog:
71
+
Run the following command to generate a changelog for this release:
**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.
0 commit comments