GitHub
Setup
-
Go to your CodSpeed settings
infoIf you are importing a repository from an organization, you need to be either a Provider Admin or a Admin of this organization. Check out the CodSpeed Roles & Permissions page for more information.
-
Click the "Import" button:
-
Select the organization or the user you want to import the repository from:
-
Select the repositories you want to benchmark and click on "Install"
-
Your repositories should appear in the list of repositories, just click on the "Enable" button to enable the repository:
-
Don't forget to note the
CODSPEED_TOKEN
that you'll need in order to upload performance reports and you're done 🎉
You can now continue and setup the continuous reporting
Permissions
CodSpeed requires the following permissions to work properly with GitHub:
-
Repository Permissions
-
Actions (Read/Write): required to access the execution logs of the workflow runs and to annotate/cancel CodSpeed workflows.
-
Administration (Read/Write): required to register CodSpeed Macro runners on repositories.
-
Checks (Read/Write): required to create check runs for the performance reports.
-
Commit statuses (Read-only): required to access commit status checks.
-
Contents (Read-only): required to access branches and commits.
-
Pull requests (Read/Write): required to access pull requests and annotate them with performance reports comments.
-
Metadata (Read-only): mandatory for all GitHub Apps.
-
-
Organization permissions
-
Members (Read-only): required to access the list of members of the organization.
-
Self-hosted runners (Read/Write): required to register CodSpeed Macro runners at the organization level.
-
-
Account permissions
- Email addresses (Read-only): required to notify users about installation and configuration changes.
If you have any concerns about the permissions we require, please contact us.