Skip to main content

​
Setup

  1. Go to your CodSpeed settings
    If 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.
  2. Click the “Import” button:
    Adding a new repository from the settings page
  3. Select the organization or the user you want to import the repository from: Github App organization selection
  4. Select the repositories you want to benchmark and click on “Install”
  5. Your repositories should appear in the list of repositories.
    Repositories list after installation
You can now continue and setup the continuous reporting.

​
GitHub Permissions

CodSpeed requires the following permissions to work properly with GitHub:

​
Account permissions

  • Email addresses (Read-only): required to notify users about installation and configuration changes.
Act on your behalfWhen you connect CodSpeed to your GitHub account, you might see a message saying the app wants to “Act on your behalf.” This message is a display inconsistency on GitHub’s side and doesn’t reflect what CodSpeed can actually do.GitHub Authorization RequestThe only permission CodSpeed requires from your personal GitHub account is read access to your email address, which allows us to identify your account and contact you if needed.All interactions will otherwise be performed through the CodSpeed GitHub App, which is installed on repositories you authorize but anyway, CodSpeed can never perform actions on your behalf. For more technical background, see this GitHub discussion.

​
Repository Permissions

  • Actions (Read/Write): required to access the execution logs of the workflow runs and to annotate/cancel CodSpeed workflows.
  • 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.
If you have any concerns about the permissions we require, please contact us.