GitHub and GitHub Enterprise Cloud

How to connect a Polaris project to a repository in GitHub or GitHub Enterprise (Cloud).

Note: Follow the steps on this page to connect a single project to a single GitHub repository. Alternatively, GitHub repositories can be imported into Polaris in bulk. For more information, see Integrate Multiple SCM Repositories.

Prerequisites

Create a personal access token

Authentication between GitHub and Polaris is managed with a personal access token (PAT) that you create in GitHub. If you haven't done so already, follow the instructions in the GitHub documentation to create an access token: GitHub > Managing your personal access tokens.

When creating an access token:

  • Set the token's expiration date. To avoid issues, we recommend No expiration.

  • Under Select scopes, access to repo is required.

Important: Store your token in a secure location. Each time you modify a project's SCM integration, you'll need to reenter the token to save your changes.
Important: To use the event-based test automation feature or synchronize the repository with Polaris, the token you use requires additional scopes (read:org (under admin:org), and admin:org_hook). See Event-Based Test Automation in Polaris for SCM Integrations and Synchronizing Polaris with your SCM Provider for more information.

Connect to a repository hosted in GitHub or GitHub Enterprise (Cloud)

To connect a project in Polaris to a repository in GitHub or GitHub Enterprise (Cloud), follow these steps:
  1. In Polaris, open the project you wish to connect to a repository (go to Portfolio, select an application, and select a project).
  2. Go to Settings > Integrations.
  3. Select Cloud-hosted.
  4. Select the source of your repository: GitHub or GitHub Enterprise.
  5. Enter the Repository URL.
    To obtain the repository's URL, open the GitHub repository in a browser and select Code. Copy the HTTPS URL (SSH is not supported).

  6. Enter the Repository Access Token.
  7. Click Test your Connection. A spinning circle indicates the test is in progress.
  8. If your connection is successful, click Save.

    If your connection test is unsuccessful, check the following and retry:

    1. Your network connection is stable.
    2. Check the Repository URL and Access Token to make sure they are accurate.
    3. Check that the Repository Access Token is still valid and has not expired.
    4. Check that you selected the correct provider for your source repository.

Next steps

Now, you can scan on demand (see How to test from the web UI) or schedule automatic testing on a daily or weekly basis (see Test scheduling policies).

Note: From the Tests screen, before beginning a test manually, make sure to test the connection.