Adding github token to authenticate rest api call#211
Open
Conversation
…website building action
Jannetty
added
type: bug
kristaphommatha
approved these changes
Mar 3, 2026
Jannetty
added a commit
that referenced
this pull request
Mar 3, 2026
adding github token to authenticate rest api call during jekyll docs website building action
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Estimated time to review: xs again
Summary of changes: This is an interesting one! And I think we only hit this bug because I tried to merge three branches in rapid succession.
We build our documentation site using Jekyll in a GitHub Action. During the build, the jekyll-github-metadata plugin queries the GitHub REST API (for example, to retrieve release information). When these API requests are made without authentication, they have a low rate limit.
Because GitHub-hosted runners share IP addresses across many workflows, and because merging multiple branches quickly triggered several documentation builds back-to-back, we exceeded this rate limit. When that happened, the API request failed, which caused the Jekyll build to error.
The change in this PR passes the automatically generated GITHUB_TOKEN to Jekyll via the JEKYLL_GITHUB_TOKEN environment variable. Authenticated API requests have a much higher rate limit, so this should prevent these intermittent build failures.
How to verify changes: I can't test this locally, but reading the fail log of the Jekyll action suggests this should fix the problem.