Skip to content

Commit 3ac3d0e

Browse files
authored
Minor: Add docs to release/README.md about rate limits (#18704)
## Which issue does this PR close? - related to #17558 ## Rationale for this change I have hit rate limit issues in the past when I didn't set my github token correctly, and @xudong963 reported something similar here: #17558 (comment) ## What changes are included in this PR? Add a note in the release docs about how to solve the rate limiting ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. -->
1 parent 17050a9 commit 3ac3d0e

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

dev/release/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,15 @@ To generate the changelog, set the `GITHUB_TOKEN` environment variable and then
169169
providing two commit ids or tags followed by the version number of the release being created. For example,
170170
to generate a change log of all changes between the `50.3.0` tag and `branch-51`, in preparation for release `51.0.0`:
171171

172+
> [!NOTE]
173+
>
174+
> If you see errors such as the following, it is likely due to not setting
175+
> the `GITHUB_TOKEN` environment variable.
176+
>
177+
> ```
178+
> Request GET ... failed with 403: rate limit exceeded
179+
> ```
180+
172181
```shell
173182
export GITHUB_TOKEN=<your-token-here>
174183
./dev/release/generate-changelog.py 50.3.0 branch-51 51.0.0 > dev/changelog/51.0.0.md

0 commit comments

Comments
 (0)