The Quality Clouds Jenkins plugin allows you to integrate your Quality Clouds scans into your DevOps / Continuous Integration pipelines.
The plugin executes scans of ServiceNow or Salesforce instances, and can be configured to mark the build as failed if any of the following conditions occurs:
- The total number of issues exceeds a given threshold
- The total amount of hours of Technical Debt exceeds a given threshold
- The Quality of Cloud indicator is below a given threshold
- The total number of high severity issues exceeds a given threshold
Installing the plugin
The plugin is available on the standard Jenkins Plugin Repository (https://plugins.jenkins.io/qualityclouds).
It is available for Jenkins versions 2.138.1 and above.
If for any reason you can not access the standard Jenkins plugin repository, you can request the hpi file from firstname.lastname@example.org, and install the plugin manually.
Creating the API credentials secret file
You need to add the Quality Clouds API key to the Jenkins Credentials.
This key is made available to you once you complete your onboarding process as a Quality Clouds customer. The key needs to be stored as a "Secret File" credential in Jenkins. This credential may be in the default Global domain, or if you prefer to define a specific domain for Quality Clouds, it must be a domain using the "hostname" specification.
The steps below show how to configure the credential in a domain. If you are using the Global domain you can skip directly to Step 4.
→ To configure the credential in a domain
- In Jenkings, choose Add a domain.
- Enter the new domain information. Make sure the specification is of type
hostname, and that the included hostname list contains "qualityclouds.com". Leave the exclude list empty.
- Add the credential to the domain.
- Configure the credential by setting the kind must be to Secret file and uploading the API key on a file to the credential, where it will be securely stored.
Configuring the plugin
Proceed to configuring the plugin once you have created the credentials.
→ To configure the plugin
- Set up a new Freestyle project.
- Add a
Quality Clouds Instance Scanbuild step.
- In step configuration, use the credential you created previously.
- Enter your SaaS instance URL (either ServiceNow or Salesforce), and the rest of the parameters which define the conditions to fail the build.
The Instance URL must match the URL you used when you defined your instance on the Quality Clouds web site.
Viewing build results
Once the build completes successfully, you are able to examine the main Quality Clouds indicators for the scan via the ScanResult link.
If the build fails, the link highlights the reason why the build was failed.