Skip to content
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.

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

update extension GitHub Profile #17906

Merged
merged 3 commits into from
Mar 17, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
4 changes: 4 additions & 0 deletions extensions/github-profile/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# GitHub Profile Changelog

## [Fix Mock Toast] - {PR_MERGE_DATE}

- 🐛 Alert user when using mock data without a GitHub token

## [Initial Version] - 2025-03-12

- 📊 View GitHub profile details, contribution heatmap, and top repositories
Expand Down
26 changes: 15 additions & 11 deletions extensions/github-profile/README.md
Original file line number Diff line number Diff line change
@@ -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
Binary file modified extensions/github-profile/metadata/github-profile-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions extensions/github-profile/src/api/github.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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();
}

Expand Down
Loading