TICS Jenkins plugin
The TICS Jenkins plugin adds two independent actions to Jenkins that can be used in your Jenkins jobs:
- Run TICS is a build step that invokes TICS as part of your Jenkins job.
Although you could also run TICS via the "Execute shell" build step that is part of the standard Jenkins installation,
the Run TICS step helps you to set the most commonly used TICS options in an easy-to-use UI.
- Publish TICS Results is a post-build step that retrieves TQI scores and deltas from the
TICS viewer and puts a TQI statement on the Jenkins job front-page. Note that you do not have to
add a Run TICS build step in order to use the Publish TICS Results build step.
Before you can use either step you need to install the TICS Jenkins plugin:
Installation
Follow the steps below to download and install the plugin in Jenkins.
- Go to the TICS download
site and download the latest available version of the plugin
(
.hpi
extension). Click to download.
- In Jenkins, go to Manage Jenkins ⇒ Manage
Plugins ⇒ Advanced ⇒ Upload
Plugin.
- Wait until Jenkins has restarted. You can verify that the plugin has been
successfully installed via Manage Jenkins ⇒ Manage
Plugins ⇒ Installed
- After installing the plugin, you can add the TICS steps to your Jenkins jobs, as described next.
Run TICS
This build step runs TICS as part of your Jenkins job. Requirements:
- You need to have TICS installed on the machine on which you want to run the job.
To configure this build step:
- Click the "Add build step" button in your Jenkins job of the project you want to analyze and select "Run TICS"
- Provide the required settings. Click the question mark icon for each option to get help.
- More advanced options become available when you click on the "Advanced..." button.
- Save the settings and choose Build Now to execute the job.
Publish TICS results
This build step adds TQI score table to your Jenkins job's front-page as depicted in the image below:
Requirements:
- You need to have a TICS Viewer running somewhere on the network
that is HTTP accessible by the machine on which you want to run the job.
To configure this post-build step:
- Click the "Add post-build action" button in your Jenkins job of the project you want to get results for and select "Publish TICS results"
- Provide the required settings. Click the question mark icon for each option to get help.
- Save the settings and choose Build Now to execute the job.