Configuring the plugin

Once the iCR build step has been added to the workflow, it needs to be configured with the information necessary to both authenticate the plugin’s access to the User’s repositories, and then to select the appropriate repository and branch for analysis. There are 8 items that need to be specified to fully configure the Jenkins plugin. These are shown in the iCR plugin window shown below:

They are:

1. Repository Host Name The name of the Version Control System (VCS) where the targeted repository is being managed. Currently, GitHub, GitLab and BitBucket are supported. In the case where local VCS servers such as GitHub Enterprise or GitLab Enterprise are deployed, those hosts are also displayed. In the example above we have used the cloud-based GitHub.

2. Personal Access Token / App Password The plugin is invoking iCR on behalf of a valid user and their repositories. In a fashion similar to how OAuth works, GitHub, GitLab or BitBucket allow an authorized app to access a User’s repositories using a secure Personal Access Token created by the specific service. How to get that token will be described in Creating a Personal Access Token. If the token/password is changed on the iCR server, it can be updated on the plugin by clicking on the Change Password button.

3. Repository Clone Link There are usually multiple possible repositories eligible for analysis via the plugin. The workflow creator needs to specify which of the User’s repositories is to be analyzed. How to find and copy that URL will be described in Copying Your Repository's URL.

4. Language Version With some languages that are analyzed by iCR, such as Python, the specific version of the language or related libraries needs to be specified in order for iCR to work correctly for the target source. The version is entered here as a text string. For example, if you are using Python 3.7, then the string 3.7 is entered.

5. Branch Name With a repository selected, the specific branch within that repository must be named. Simply enter the text string for the branch name here.

6. iCR Server Address (URL) With a Private Platform Deployment, the iCR for Java server is established with a known IP address. Per the Private Platform User Guide, the URL for the server is the IP address followed by the port 3001. E.g. https://<iCR_IP_Address>:3001.

7. iCR Server Access Key The Navigator on each instance of iCR server is protected with a password. This prevents unauthorized access to the iCR server. The text for that password is entered here. If the password is changed on the iCR server, the password can be updated on the plugin by clicking on the Change Password button.

8. Notification email Address When the analysis triggered by this plugin completes, the User, upon whose behalf this analysis was performed, can receive an email notification letting them know it is complete. That User’s email can be entered here. An address MUST be provided to allow a way for iCR to notify the User in the event of either success of some kind of failure.

Note: Clicking on the icon for each entry will pop up a brief help text to guide you with the contents of that field.