Documentación Análisis desde tu pipeline de CI

Analiza cada cambio y para el pipeline cuando aparezca algo grave. El análisis desde CI está incluido a partir del plan Skipper.

Configuración

  1. Crea un token de acceso en los ajustes de tu cuenta.
  2. Guárdalo en tu sistema de CI como un secreto llamado SC_TOKEN.
  3. Añade a tu pipeline los pasos de abajo.

GitHub Actions

- uses: actions/checkout@v4

- name: Install sc
  run: curl -fsSL https://scancodebase.com/install.sh | sh

- name: Scan the code
  env:
    SC_TOKEN: ${{ secrets.SC_TOKEN }}
  run: sc code . --fail-on high --format sarif --output scan.sarif

- name: Show the findings in GitHub
  if: always()
  uses: github/codeql-action/upload-sarif@v3
  with:
    sarif_file: scan.sarif

GitLab CI

scan:
  stage: test
  script:
    - curl -fsSL https://scancodebase.com/install.sh | sh
    - sc code . --fail-on high
  after_script:
    - sc download last --format pdf --output report.pdf
  artifacts:
    when: always
    paths:
      - report.pdf

En GitLab, añade SC_TOKEN como variable enmascarada en los ajustes de CI/CD del proyecto.

Azure DevOps

- script: curl -fsSL https://scancodebase.com/install.sh | sh
  displayName: Install sc

- script: sc code . --fail-on high
  displayName: Scan
  env:
    SC_TOKEN: $(SC_TOKEN)

Otros sistemas de CI

Jenkins, CircleCI, Bitbucket Pipelines y los demás funcionan igual: instala sc, define SC_TOKEN y ejecuta el comando de análisis.

Decide cuándo se para el pipeline

ComandoEl pipeline se para cuando
sc code . --fail-on criticalHay un hallazgo crítico.
sc code . --fail-on highHay un hallazgo alto o crítico.
sc code .Nunca. El análisis solo informa.

Empieza sin la opción, mira unos cuantos informes y después elige el nivel que tu equipo pueda mantener en verde.

Sin instalar nada

Un git push desde el pipeline también lanza un análisis. No puede parar el pipeline, porque el resultado llega después de que termine el push.

- name: Scan with scancodebase
  run: |
    git remote add scancodebase https://your-user:${{ secrets.SCANCODEBASE_TOKEN }}@scancodebase.com/your-user/myapp.git
    git push scancodebase HEAD:main

Escanea el tuyo antes del próximo merge.