GitLab Runner Integration

GitLab is an open-core company that provides GitLab, a DevOps software package that combines the ability to develop, secure, and operate software in a single application. Its application, GitLab Runner, works with GitLab CI/CD to run jobs in a pipeline.

The following configuration examples show how to install & run the scanner using an API Token stored as a secret named XYGENI_TOKEN. See Generate Xygeni API Token for Scanner or ask your Xygeni administrator to generate it.

See CI/CD variables and using external secrets in CI for details on how to register the Xygeni API token for use in GitLab CI.

Using the installation script

You may automatically install the scanner using the installation script available from https://get.xygeni.io/latest/scanner/TYPE, with TYPE either bash or powershell:

build-job:
  stage: scan
  script:
    - >
      curl -L https://get.xygeni.io/latest/scanner/install.sh |
      /bin/bash -s -- -o -t $XYGENI_TOKEN
    - >
      $HOME/.xygeni/xygeni scan \
         -n ${CI_PROJECT_NAME} --dir ${CI_PROJECT_DIR}

See installation script for more details.

Please refer to the scanner documentation for full details on the scanner command line options and configuration.

Using the docker image

If it is not possible to install the scanner in the GitLab host running the pipeline, you may run the docker image instead:

build-job:
  stage: scan
  script:
    - >
      docker run
        -v $PROJECT_HOME:/app
        -v $DD_CONF:/opt/xygeni_scanner/conf
        -t -rm xygeni_scanner/xygeni scan
        -n $PROJECT_NAME --dir /app

See Xygeni Scanner docker image for more details.