Unified Language User Guides
iCR User Guide 4.2
iCR User Guide 4.2
  • Table of contents
    • Introduction
    • Overview
    • Authorizing Access to Your Source Code
      • Authenticating GitHub Access with a Cloud-Based VCS Repository Service
        • Authenticating GitHub Access with a Private VCS Repository
      • Authenticating GitLab Access with a Cloud-Based VCS Repository
        • Authenticating GitLab Access with a Private VCS Repository
      • Authenticating Bitbucket Access with a Cloud-Based VCS Repository
    • Using the Navigator
      • Connecting to the Navigator
      • Setting your User Password
      • The Navigator top banner
      • The Analysis Engine status
      • Selecting Your Source Code
        • Using a cloud-based VCS
        • Selecting your branch
        • Using a private VCS
        • Using a local project
        • Limiting the files to be analyzed
      • Integrating with your bug tracking system
        • Integrating with Jira - Define Your Project
        • Integrating with Jira - Authorizing Access for iCR
        • Integrating with Jira - Connecting with iCR
    • Using the Analysis Engine
      • Initiating an analysis
      • Monitoring the analysis
      • Interrupting the analysis
    • Reviewing your results
    • When you are complete
    • Integrating iCR Into Your CI/CD Workflows
      • Jenkins Workflow
        • Installing the plugin
        • Configuring the plugin
          • Creating a Personal Access Token
          • Copying Your Repository's URL
        • Viewing the Results
      • GitHub Actions Workflow
        • Workflow Overview
        • Preparing and Registering the Docker Image
        • Adding a Workflow to a Repository
        • Preparing the GitHub Workflow
          • Environment Variables
          • User Supplied Secrets
          • Setting the User Defined Secrets Values
        • Executing the Workflow
      • GitLab Workflow
        • Workflow Overview
        • Preparing the Docker Image
        • Configuring the GitLab Script variables
          • Environment Variables
          • User Supplied Variables
          • Creating a Personal Access Token
          • Setting the User Defined Variable Values
        • Executing the Workflow
      • Multiple Workflows
    • Appendix – Language Specific Fixer Lists
    • Appendix – Example Summary Report
    • Appendix - Sample Bug Listing
    • Appendix - Getting a BitBucket App Password for JENKINS
Powered by GitBook
On this page
  1. Table of contents
  2. Integrating iCR Into Your CI/CD Workflows
  3. GitHub Actions Workflow
  4. Preparing the GitHub Workflow

User Supplied Secrets

PreviousEnvironment VariablesNextSetting the User Defined Secrets Values

Last updated 10 months ago

User specified variables which are encrypted for security purposes are referred to as “secrets” in GitHub Actions. They are provided by the DevOps engineer who is developing the workflow. They are needed in order to identify the iCR server to be used for analysis and its accompanying configuration parameters. They are:

  1. secrets.ICR_URL ``Provide the URL to the location of the iCR server to be used for the analysis and review. Using examples from the Private Platform User Guide, the url would look like: http://3.237.77.219:3001 **** ****Where 3.237.77.219 is the IP address of the iCR server and 3001 is the TCP port that the Navigator uses.

  2. secrets.ICR_USER_NAME The Navigator requires the workflow to login into iCR using a specific iCR user name. This field is a string that specifies the User Name.

  3. secrets.ICR_CI_CD_ACCESS_TOKEN In concert with the ICR_USER_NAME, that User needs to be authenticated before it can access iCR functionality. So that passwords are not exchanged between the yml script and iCR, an encrypted token is used. The ICR_CI_CD_ACCESS_TOKEN is created by the User within the iCR Navigator. You can see how that is done in the User Guide section titled .

  4. secrets.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. For example, if you are using Python 3.7, then the string 3.7 is assigned.

  5. secrets.PERSONAL_ACCESS_TOKEN ``To authorize the workflow to operate upon the project on behalf of a specific user, that workflow needs to supply a Personal Access Token (PAT) that authorizes access to their repositories. You can reuse the token you used in , or you can create another one as described in .

  6. secrets.MAIL_ADDRESS ``When the analysis triggered by this workflow completes, the User, upon whose behalf this analysis was performed, will receive an email notification letting them know it is complete. That User’s email will be entered here. An email 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. If no address is provided the workflow will not proceed.

The Navigator top banner
Preparing and Registering the Docker Image
Creating a Personal Access Token