Skip to content

Rate limit errors for changelog command #2460

@lcawl

Description

@lcawl

Describe the bug

While testing #2350 with a long list of PRs, I start hitting these warnings:

warn ::d.b.d.Log             :: Failed to fetch PR information from GitHub for PR: 247964. Generating basic changelog with provided values.
warn ::e.d.s.c.itHubPrService:: Failed to fetch PR info. Status: Forbidden, Reason: rate limit exceeded

In this case it's a list of 40 PRs that I'm creating changelogs for like this:

./docs-builder changelog add --prs ./test-serverless/kibana-2025-01-13.txt --repo kibana --owner elastic --products "cloud-serverless 2025-01-13" --config ~/Documents/GitHub/kibana/docs/changelog.yml --output ~/Documents/GitHub/kibana/docs/changelog/2025-01-13/

I think the use case were we're creating that many changelogs at once is likely an edge case, but I think we ought to:

  1. Figure out what the limit is and provide guidance for avoiding this type of error.
  2. Ensure that it doesn't affect the bundle or render commands, which are more likely to continue to have this type of volume they're processing.

Expected behavior

Ideally we'd avoid rate limit errors. If that's not possible, we should advise users to have a smaller list of PRs in each command.

Steps to reproduce

  1. Create a text file that contains a newline-delimited list of PRs. For example:
245588
247398
247003
247638
246978
247965
246640
247691
243011
246540
246073
247417
246979
245441
247002
247964
248444
247996
248068
247015
247885
246088
247880
247707
247678
248020
248439
247615
247641
247982
248072
248204
248462
247877
247721
247836
247531
247992
247744
247808
  1. Check out Add PR label blockers to changelog creation #2350
  2. Check out [DOCS] Add changelog configuration file kibana#247875 and uncomment the add_blockers section of the changelog.yml configuration file.
  3. Generate changelogs for this list of PRs. For example:
     ./docs-builder changelog add --prs ./test-serverless/kibana-2025-01-13.txt --repo kibana --owner elastic --products "cloud-serverless 2025-01-13" --config ~/Documents/GitHub/kibana/docs/changelog.yml --output ~/Documents/GitHub/kibana/docs/changelog/2025-01-13/

Tooling

  • docs-builder
  • migration tooling
  • I'm not sure

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions