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. Jenkins Workflow

Installing the plugin

PreviousJenkins WorkflowNextConfiguring the plugin

Last updated 10 months ago

Jenkins uses plugins to control a step in a workflow. A plugin is a script that can be inserted anywhere into a workflow. While a user may retrieve a plugin from the Jenkins registry, OpenRefactory provides the plugin in the distribution package to make it simple for customers to integrate iCR into a Jenkins workflow.

It is likely that the platform running the Jenkins infrastructure is separate from the platform executing iCR. Therefore, it is expected that the person installing iCR will copy the provided plugin onto the server running the Jenkins framework. It should be placed in the appropriate directory used by Jenkins so it can discover and use the plugin. The default directory for this is typically /var/lib/jenkins/plugins.

Once placed in the plugins directory, it is available for use by the designer of the workflow.

NOTE: Once the plugin has been copied to the proper directory, Jenkins must be in order for the plugin to be recognized by Jenkins.

In the example below, the workflow creator is in the Build step phase. By clicking on Add build step a pull-down menu of options appears. Because the icrPlugin.hpi file was added to the Jenkins plugin directory, iCR for Java appears as one of the Build step options.

Selecting it will insert it into the workflow.

restarted