GitLab CI Integration

Discover Scantist's capabilities with GitLab CI integration

GitLab CI

GitLab CI is a continuous integration solution provided by GitLab that simplifies and automates the process of integrating code changes into a shared repository. With Gitlab CI, each code commit triggers an automated build process, provided that a pipeline is within your GitLab environment. It can be integrated with GitHub, GitHub Enterprise and Bitbucket.

Integrating Scantist into the development lifecycle of GitLab CI can help enforce security and licensing compliance within your CI/CD pipeline.

Steps for Integration with Gitlab CI

Follow the following steps to integrate Scantist with your Gitlab CI.

Step 1 - Create access token

You will need to create an access token on Scantist to authenticate and authorize the integration.

Step 2 - Setup Environmental Variables on Gitlab CI

Once you have copied your access token, navigate back to Gitlab CI.

1. Select Settings > CI/CD from your left panel.

   

2. Scroll to the Variables section, then click on the Expand button.

   

3. Click on the Add Variable button. In the pop-up box,

   • Set the Key as SCANTISTTOKEN
   • Paste your access token under Value
   • Check the option Mask variable
   • Complete the process by clicking on the Add Variable button

   

   Click on the Add Variable button again. In the pop-up box,

   • Set the Key as SCANTIST_IMPORT_URL
   • Set the Value as https://api-v4staging.scantist.io/v2/scans/ci-scan/ (for V4 staging environment) or https://gcc.scantist.io/v2/scans/ci-scan/ (for GCC environment)
   • Check the option Mask variable
   • Complete the process by clicking on the Add Variable button

Step 3 - Add .gitlab-ci.yml on your repo

Assuming that your code is hosted on Gitlab, the final step you will need to do is to add or merge the last two lines of code at the bottom of your .gitlab-ci.yml file in your repository. This command will download and execute our BOM Detector to scan after the build.

job:
  script:
    - curl -s https://download.scantist.io/sca-bom-detect.jar --output sca-bom-detect.jar
    - java -jar sca-bom-detect.jar

Once the command has been added to your .gitlab-ci.yml file, Gitlab CI will trigger a new build automatically and push the 3rd party component information of your project to Scantist SCA after the successful build.

An example of a .gitlab-ci.yml file

stages:
  - build

build-job:
  stage: build
  script:
    - apt-get update && apt-get install -y nodejs npm default-jdk
    - cd api
    - npm install
    - curl -s https://download.scantist.io/sca-bom-detect.jar --output sca-bom-detect.jar
    - java -jar sca-bom-detect.jar