GitHub App
Overview
The Axiomatic GitHub App is an optional, read-only integration used by the web dashboard. It allows the dashboard to list your repositories and verify collaborator access so that all contributors to a repo can see its test results.
The GitHub App does not post PR comments. PR comments are handled directly by the GitHub Action, which uses the built-in GITHUB_TOKEN -- no app installation needed.
What the GitHub App Does
- Repository discovery: The dashboard uses the app to list repos you've granted access to, so you can see them in the UI without manually syncing each one.
- Collaborator verification: When multiple people contribute to a repo, the app checks GitHub permissions to determine who can view results on the dashboard.
What the GitHub App Does Not Do
- It does not post PR comments or reviews.
- It does not create or update check runs.
- It does not have write access to your code or repository settings.
Setup
- Go to your dashboard settings and click Install GitHub App
- Choose which repositories to grant access to (or select all)
- The dashboard will automatically show test results for those repositories
PR Comments
PR comments are posted by the GitHub Action, not the GitHub App. See the CI/CD Integration guide for setup instructions.
The Action uses the standard GITHUB_TOKEN provided by GitHub Actions, which already has permission to comment on PRs in your repository. This means:
- No additional app installation is needed for PR feedback
- PR comments work on the Free tier (no paid plan required)
- You retain full control over the workflow and comment format
Permissions
The GitHub App requests the following permissions:
| Permission | Level | Purpose |
|---|---|---|
| Repository metadata | Read | List repos and basic info |
| Pull requests | Read | Display PR metadata on the dashboard |
| Members | Read | Verify collaborator access for shared visibility |
The app has no write permissions on your repositories.
Shared Repository Access
When the GitHub App is installed, all collaborators on a repository can view its test results on the dashboard. Access is determined by checking GitHub's collaborator list -- if you have at least read access to the repo on GitHub, you can see its results on Axiomatic.
This means:
- Team members see each other's test runs without any extra configuration
- When someone loses access to the repo on GitHub, they also lose access on the dashboard
- No manual invite or team management is needed