Skip to end of metadata
Go to start of metadata

The GitHub integration allows you to scan your GitHub repository directly and connect it to your WhiteSource projects without needing a local clone / copy of your remote GitHub repository.

 

Pre-Requisites 

You should have an existing GitHub account with a public email account.

In order to make sure that your email is public please login to your GitHub repository and click on edit profile at the top right corner:

 

Then, on the “Profile” section, please make sure that you have your email set as the public email. Once complete, click on “Update Profile”:

Add your GitHub user 

The first thing that you should do in order to use the GitHub integration feature is to associate your WhiteSource portal user with your GitHub user.

In Order to do so please click on your name, at the upper right corner and select profile from the drop-down menu:

 

In the user profile management screen click on Associate Social Account:

 

Select GitHub on the next screen and login using your GitHub credentials:

on the next screen, please click on “Authorize Application”:

You can now see your GitHub account under your Social Identities section:

Setup a GitHub scan 

In order to setup a GitHub scan, we will go to the Admin menu and click on “GitHub Repository Scan”:

In the GitHub Repository scan you can select the specific branches and tags that you wish to scan by specifying a user and a repository. Once decided click on select in order to add the desired repository to the selected repositories list.

For each repository, under the “project” column, please specify whether to create a new project or to scan the repository into an existing one.

Once Completed click on Save and the information will be saved for future use.

Run a GitHub scan 

In order to run a scan, click on “Scan Repositories” at the lower part of the GitHub Repository Scan screen .

You will receive a notification that a scan has begun:

In addition, as long as the scan is at progress, you will see an indication near the “Scan Repositories” button:

 

 

Labels
  • None