Integrating CodeScan in Bitbucket Pipelines
Integrating CodeScan into your Bitbucket pipeline is easy with our sfdx plugin. There are only a few lines to add to your .YML file to run CodeScan when a build is triggered.
The following is based on a docker pipeline with Java and Node installed in the container.
First, we'll need to add your CodeScan token as a variable we can access in our .YML file.
- Open your project and navigate to Repository Settings > Repository Variables (you'll find this under Pipelines).
- Add your token with the name codescan_token and check the Secured box. To learn how to generate a token, refer to the article Generate a Security Token.
- Now you'll be able to access this variable by using $codescan_token in your .YML file.
Add the following into your .YML file:
The install scripts for the sfdx plugin have been added to the steps below to provide easy boiler plate code. This installation should be completed in the container in a production pipeline.
image: salesforce/salesforcedx #Your docker image, complete with node and java (8+) installed. pipelines: pull-requests: 'master': #The destination branch of the pull requests we’ll be checking - step: caches: - node script: - echo y|sfdx plugins:install sfdx-codescan-plugin - sfdx codescan:run --token=$codescan_token --projectkey=project1 --organization=<your CodeScan Cloud Organisation key> branches: 'master': #The branch of the project we’ll be tracking the history of - step: caches: - node script: - echo y|sfdx plugins:install sfdx-codescan-plugin - sfdx codescan:run --token=$codescan_token --projectkey=project1 --organization=<your CodeScan Cloud Organisation key>
You will need to replace the placeholder variables (in bold) in the script with your Organization Key.
The pull request names keys are set by the following parameters:
- sonar.pullrequest.key: This is the PR number.
- sonar.pullrequest.branch: The name of the branch.
- sonar.pullrequest.base: The destination branch of the PR. This also determines where the comparison is made in the CodeScan project.
By managing the conditionals in your script that determines what triggered the build and defining the branch type, name, and target using Bitbucket pipeline's built in variables, you can create a project that gives you visibility on your new code while allowing you to plan your refactoring effort.
By default, the CodeScan SFDX plugin will fail if the Quality Gate fails. If you would prefer that the build passes despite the quality gate, use the --nofail tag when calling sfdx codescan:run.
You can find a complete list of flags and examples on our npm plugin page.