Azure DevOps Pipelines

CodeCharter läuft in Azure Pipelines als Shell-Step. Robust, einfach zu pinnen, ohne externe Abhängigkeiten außer dem CLI-Download.

Minimal-Setup

azure-pipelines.yml:

trigger:
  branches:
    include: [main]

pr:
  branches:
    include: [main]

pool:
  vmImage: ubuntu-latest

variables:
  CODECHARTER_VERSION: '1.4.0'

steps:
  - task: UseDotNet@2
    inputs:
      version: '9.0.x'

  - bash: |
      curl -sSL -H "Authorization: Bearer $(CODECHARTER_API_KEY)" \
        -o codecharter.tar.gz \
        https://codecharter.tools/api/v1/cli/linux-x64/$(CODECHARTER_VERSION)
      mkdir -p /opt/codecharter && tar -xzf codecharter.tar.gz -C /opt/codecharter
      chmod +x /opt/codecharter/codecharter
      echo "##vso[task.prependpath]/opt/codecharter"
    displayName: 'Install CodeCharter CLI'
    env:
      CODECHARTER_API_KEY: $(CodeCharterApiKey)

  - bash: |
      codecharter analyze . --fail-on error --output sarif --output-file codecharter.sarif
    displayName: 'Run CodeCharter'

  - task: PublishBuildArtifacts@1
    condition: always()
    inputs:
      pathToPublish: codecharter.sarif
      artifactName: codecharter-sarif

API-Key in Pipeline-Secret

1. Im Portal unter API Keys einen Key erzeugen.
2. In Azure DevOps: Pipelines → Library → Variable groups → New, Variable CodeCharterApiKey mit Wert anlegen, Lock-Icon klicken (macht sie zum Secret).
3. In der Pipeline-YAML auf die Variable referenzieren wie oben gezeigt.

SARIF anzeigen

Azure DevOps hat keinen nativen SARIF-Viewer. Zwei gute Optionen:

Option A. SARIF-Viewer-Extension

Es gibt eine SARIF SAST Scans Tab Marketplace-Extension. Nach der Installation taucht ein "Scans"-Tab neben Tests und Code Coverage auf, der SARIF-Artifacts rendert.

Option B. Markdown-Report

- bash: |
    codecharter analyze . --output console --output-file codecharter-report.txt
    echo "##vso[task.uploadsummary]$PWD/codecharter-report.txt"
  displayName: 'Publish CodeCharter summary'

uploadsummary hängt den Text an die Build-Summary an. Kein hübsches UI, aber sichtbar.

Caching

Azure Pipelines hat Cache@2:

- task: Cache@2
  inputs:
    key: 'codecharter | "$(Agent.OS)" | .codecharter/**/* | **/*.csproj'
    path: $(Pipeline.Workspace)/.cache/codecharter
  displayName: 'Cache CodeCharter'

- bash: codecharter analyze . --fail-on error
  env:
    CODECHARTER_CACHE_DIR: $(Pipeline.Workspace)/.cache/codecharter

Self-Hosted Agents

Funktioniert ohne Anpassungen. Der Agent braucht Netzzugriff auf codecharter.tools oder ihr spiegelt das CLI-Binary in euer eigenes Artifact-Feed.