Skip to content

docs(github): clarify stargazer listing access #1164

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

Open
TheMostlyGreat wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −1
Open

docs(github): clarify stargazer listing access #1164

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
21 changes: 20 additions & 1 deletion app/en/references/auth-providers/github/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -878,9 +878,15 @@ This section lists the GitHub App permissions required by tools in the Arcade Gi

**Basic (Read-only):**

- `count_stargazers`, `get_repository`, `list_repository_activities`, `list_stargazers`, `get_file_contents`
- `count_stargazers`, `get_repository`, `list_repository_activities`, `get_file_contents`
- Required: Contents (Read), Metadata (Read)

**Restricted stargazer listing:**

- `list_stargazers`
- The app needs read access to repository metadata, and the authenticated user must be an administrator or collaborator on the repository
- Use `count_stargazers` when you only need the public aggregate count

**Write Operations:**

- `create_branch`, `create_or_update_file`, `update_file_lines`
Expand Down Expand Up @@ -976,6 +982,18 @@ GitHub doesn't reveal which repositories exist when you lack access (security by
3. Ensure the user has authorized the app
4. Confirm the repository path is correct

### Stargazer listings require repository access

GitHub limits its list stargazers endpoint to repository administrators and
collaborators. `list_stargazers` can return `404 Not Found` or `403 Forbidden`
for a public repository even when the app has Metadata (Read) permission and
can otherwise read that repository.

Use `count_stargazers` when you only need the public number of stars. It reads
the repository's aggregate `stargazers_count` instead of enumerating users.

[Learn about GitHub's stargazer access restrictions](https://github.blog/changelog/2026-06-30-upcoming-access-restrictions-to-public-api-endpoints-and-ui-views/)

### Installing on Additional Repositories

After initial installation, you can add more repositories:
Expand Down Expand Up @@ -1017,6 +1035,7 @@ After initial installation, you can add more repositories:
| **"Installation not found"** | Wrong Installation ID | Check Installation ID in URL |
| **"403 Forbidden"** | Missing permissions, not installed, or rate limited | Review permissions, check installation |
| **"404 Not Found" on existing repo** | Permissions not approved by admin | Check app settings → verify permissions approved |
| **Can't list stargazers on a public repo** | User isn't a repository administrator or collaborator | Use `count_stargazers` for the public count |
| **Can't star repositories** | Missing "Act on behalf of user" permission | Enable in User permissions settings |

### Debugging Steps
Expand Down
Loading