Skip to content

fix(github-stars): authenticate preload and don't fail the build on error #1281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LiamRandall merged 1 commit into from
Oct 2, 2026
Merged

fix(github-stars): authenticate preload and don't fail the build on error #1281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions packages/docusaurus-github-stars/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,18 @@ export default async function githubStars(
return;
}
const [owner, repo] = options.preloadRepo.split('/');
const octokit = new Octokit();
const response = await octokit.repos.get({ owner, repo });
if (response.status !== 200) {
logger.report('throw')(`Failed to fetch repo data for ${options.preloadRepo}`);
// Authenticate when a token is available: anonymous requests share a
// 60/hour limit per IP, which CI and Netlify build machines exhaust.
const octokit = new Octokit({ auth: process.env.GITHUB_TOKEN });
try {
const response = await octokit.repos.get({ owner, repo });
return response.data;
} catch (err) {
// Star counts are cosmetic: the client fetches them at runtime when
// nothing was preloaded, so a GitHub failure shouldn't fail the build.
logger.warn(`Failed to preload repo data for ${options.preloadRepo}: ${err}`);
return undefined;
}
return response.data;
},
injectHtmlTags: ({ content }) => {
if (!content) return {};
Expand Down
Loading