Integrate a GitHub Repository (Cloud-hosted)

How to integrating a single GitHub or GitHub Enterprise (Cloud) repository to a project.
Note: The Black Duck Security Scan Action is the preferred method for integrating the GitHub pipeline with Polaris.

For information about bulk integration, see Integrate Multiple SCM Repositories.

Steps for Integrating a GitHub Repository (Cloud-hosted) to a Project

This allows you to select the repository when creating a new test for the project (see How to test from the web UI). Only one repository can be used per project.
  1. From Application, select a Project and navigate to Settings > Integrations.
  2. Select Cloud-hosted.
  3. Select the source of your repository: GitHub or GitHub Enterprise.
  4. Enter the Repository URL.
    To obtain the repository 's URL, open your repository, click the Code button, copy the HTTPS URL (SSH is not supported).
    Figure 1. GitHub example


  5. Enter the Repository Access Token.
    Generate an access token in GitHub then paste it into the text field.
    Note: Due to security reasons, if you change any of your repository settings, you will have to enter the Access Token again.

    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.

    Note: For more information on creating access tokens, see the documentation for GitHub and GitHub Enterprise.
  6. Click Test your Connection. A spinning circle indicates the test is in progress.
  7. 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.
  8. If your connection is successful, click Save.
Now, you can then 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.