diff --git a/extensions/github-profile/CHANGELOG.md b/extensions/github-profile/CHANGELOG.md index fb712055a94..5d3a76fbb4e 100644 --- a/extensions/github-profile/CHANGELOG.md +++ b/extensions/github-profile/CHANGELOG.md @@ -1,5 +1,9 @@ # GitHub Profile Changelog +## [Fix Mock Data] - 2025-03-17 + +- đ Change GitHub token as required field + ## [Initial Version] - 2025-03-12 - đ View GitHub profile details, contribution heatmap, and top repositories diff --git a/extensions/github-profile/README.md b/extensions/github-profile/README.md index 6d6a552172c..c17cf6c53e6 100644 --- a/extensions/github-profile/README.md +++ b/extensions/github-profile/README.md @@ -1,21 +1,25 @@ -# GitHub Profile Viewer +# GitHub Profile Viewer đ§âđģ -View GitHub user profiles directly from Raycast. +View GitHub user profiles directly from Raycast. đĻ ## Setup -### GitHub Token (Optional but Recommended) +### GitHub Token đ -To avoid GitHub API rate limiting, you can add a Personal Access Token: +You need to add a GitHub token to use this extension: -1. Create a token at [GitHub Settings](https://github.com/settings/tokens) - - No specific scopes are needed for public data - - For private data, select appropriate scopes +1. Create a token at [GitHub Settings](https://github.com/settings/tokens). 2. Add this token to the extension preferences in Raycast +**! Please remind that the token is required** â ī¸ + ## Features -- View user profile details -- See followers and following counts -- Display user's repositories -- Open profiles directly in browser +- âšī¸ View user profile details +- đĨ See followers and following counts +- đ Display user's repositories +- đ Open profiles directly in browser + +## Roadmap + +- [ ] Regular REST API (used for profile and repositories) can work without a token but with rate limits diff --git a/extensions/github-profile/metadata/github-profile-1.png b/extensions/github-profile/metadata/github-profile-1.png index f9f67c81b0c..ccb9d14308a 100644 Binary files a/extensions/github-profile/metadata/github-profile-1.png and b/extensions/github-profile/metadata/github-profile-1.png differ diff --git a/extensions/github-profile/package.json b/extensions/github-profile/package.json index 87f71d87069..1553c1faeca 100644 --- a/extensions/github-profile/package.json +++ b/extensions/github-profile/package.json @@ -33,7 +33,7 @@ "title": "GitHub Personal Access Token", "description": "Your GitHub personal access token (optional, but recommended to avoid rate limits)", "type": "password", - "required": false, + "required": true, "placeholder": "ghp_xxxxxxxxxxxxxxxx" } ], diff --git a/extensions/github-profile/src/api/github.ts b/extensions/github-profile/src/api/github.ts index 133ba108206..b3d1cafec12 100644 --- a/extensions/github-profile/src/api/github.ts +++ b/extensions/github-profile/src/api/github.ts @@ -104,6 +104,7 @@ export const fetchContributionData = async (username: string): Promise<Contribut if (!preferences.githubToken) { // If no token provided, return mock data + showFailureToast("â ī¸ Showing MOCK data without token"); return generateMockContributionData(); }