Skip to content

Pass the GitHub token to the docs-check CI steps - #5641

Merged
obenland merged 1 commit into
mainfrom
fix/ci-generate-docs-token
Oct 13, 2026
Merged

obenland merged 1 commit into
mainfrom
fix/ci-generate-docs-token

Conversation

@obenland

Copy link
Copy Markdown
Member

Fixes

Intermittent failures of "Run catalog checks" and "Run Nuxt checks (test_media_props)", seen today on #5639 and #5640.

Description

The generated-documentation checks (catalog/generate-docs, api/generate-docs, frontend/generate-docs) run prettier on the generated file through just lint, which first runs the precommit recipe. That recipe fetches the latest pre-commit release from the GitHub API with curl, authenticated only when GITHUB_TOKEN is set. These steps never set it, so the request was unauthenticated and subject to the per-IP rate limit shared by hosted runners. When many jobs ran at once (today's burst of Renovate PRs), the request failed, the || true in the recipe hid it, prettier never ran, and the check failed on the formatting differences between the raw generated file and the committed one.

The evidence: on the failing runs the "Running linting..." step took 0.16 to 1 second; on passing runs it takes 6 to 13 seconds. The "Lint files" job already passes the token for the same reason. This does the same for the three docs-check steps.

Testing Instructions

CI. The catalog, API and Nuxt check jobs run on this PR.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where applicable.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

🤖 Generated with Claude Code

The generated-documentation checks for the catalog, API and frontend run
prettier through pre-commit, and the `precommit` recipe downloads
pre-commit from the GitHub releases API first. Those steps did not set
GITHUB_TOKEN, so the download ran unauthenticated and hit the per-IP
rate limit whenever many jobs ran at once. The recipe swallows that
failure, prettier never runs, and the check fails on formatting
differences in the generated file. The lint job already passes the
token; do the same here.

Co-Authored-By: Claude Mythos 5.1 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings October 13, 2026 16:18
@obenland
obenland requested a review from a team as a code owner October 13, 2026 16:18
@obenland obenland added 🟩 priority: low Low priority and doesn't need to be rushed 🛠 goal: fix Bug fix 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: mgmt Related to repo management and automations labels Oct 13, 2026
@obenland
obenland requested review from dhruvkb and krysal and removed request for a team October 13, 2026 16:18

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@openverse-bot openverse-bot moved this to 👀 Needs Review in Openverse PRs Oct 13, 2026
@github-actions

Copy link
Copy Markdown

Latest k6 run output1

     ✓ status was 200

     checks.........................: 100.00% ✓ 404      ✗ 0   
     data_received..................: 98 MB   406 kB/s
     data_sent......................: 128 kB  533 B/s
     http_req_blocked...............: avg=70.58µs  min=951ns    med=4.57µs   max=1.47ms   p(90)=173.22µs p(95)=349.97µs
     http_req_connecting............: avg=58.04µs  min=0s       med=0s       max=1.4ms    p(90)=89.68µs  p(95)=304.28µs
     http_req_duration..............: avg=109.03ms min=13.16ms  med=71.93ms  max=586.21ms p(90)=245.5ms  p(95)=288.33ms
       { expected_response:true }...: avg=109.03ms min=13.16ms  med=71.93ms  max=586.21ms p(90)=245.5ms  p(95)=288.33ms
   ✓ http_req_failed................: 0.00%   ✓ 0        ✗ 404 
     http_req_receiving.............: avg=138.29µs min=35.98µs  med=127.79µs max=402.95µs p(90)=200.88µs p(95)=237.54µs
     http_req_sending...............: avg=20.1µs   min=4.28µs   med=18.12µs  max=86.1µs   p(90)=29.57µs  p(95)=41.61µs 
     http_req_tls_handshaking.......: avg=0s       min=0s       med=0s       max=0s       p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=108.87ms min=13.05ms  med=71.8ms   max=586.01ms p(90)=245.34ms p(95)=288.11ms
     http_reqs......................: 404     1.679678/s
     iteration_duration.............: avg=576.96ms min=220.44ms med=592.59ms max=1.15s    p(90)=781.43ms p(95)=810.67ms
     iterations.....................: 77      0.320137/s
     vus............................: 0       min=0      max=3 
     vus_max........................: 60      min=60     max=60

Footnotes

  1. This comment will automatically update with new output each time k6 runs for this PR ↩

@obenland
obenland merged commit 434f9a5 into main Oct 13, 2026
78 checks passed
@obenland
obenland deleted the fix/ci-generate-docs-token branch October 13, 2026 16:37
@github-project-automation github-project-automation Bot moved this from 👀 Needs Review to 🤝 Merged in Openverse PRs Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🤖 aspect: dx Concerns developers' experience with the codebase 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: mgmt Related to repo management and automations

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants