GitLab CI/CD Workflow

Add the following to your .gitlab-ci.yml. It will trigger on every push to your target branch and kick off a CodeAnt analysis scan:
stages:
  - scan

scan_codeant:
  stage: scan
  image: python:3.11
  script:
    - echo "Fetch CodeAnt scan script"
    - export API_BASE="https://api.codeant.ai"
    - curl -sS -X GET "${API_BASE}/analysis/ci/scan/script/get" \
        --output start_scan.sh.b64
    
    - echo "Make script executable"
    - base64 -d start_scan.sh.b64 > start_scan.sh
    - chmod +x start_scan.sh
    
    - echo "Trigger CodeAnt analysis"
    - bash start_scan.sh \
        -a "$ACCESS_TOKEN" \
        -r "$CI_PROJECT_PATH" \
        -c "$CI_COMMIT_SHA" \
        -b "$CI_COMMIT_REF_NAME" \
        -s gitlab \
        -i "" \
        -e ""
  only:
    - main

Script Parameters

The start_scan.sh script accepts the following parameters:

Required Parameters

ParameterFlagDescriptionExample
Access Token-a, --access-tokenAuthentication token for CodeAnt API. Can be a Personal Access Token (PAT) or repository token$ACCESS_TOKEN
Repository-r, --repoRepository name in organization/repository formatmyorg/myrepo
Commit ID-c, --commit-idGit commit SHA to analyze$CI_COMMIT_SHA
Service-s, --serviceGit service providergitlab, github, bitbucket

Optional Parameters

ParameterFlagDefaultDescription
Branch-b, --branch(empty)Branch name for the analysismain, develop
Include Files-i, --include-files(empty)Glob patterns for files to include in analysis"src/**/*.js"
Exclude Files-e, --exclude-files(empty)Glob patterns for files to exclude from analysis"**/test/**"
Polling Interval-p, --polling-interval30Seconds between result polling attempts20
Timeout-t, --timeout300Maximum seconds to wait for results600
No Wait-n, --no-waitfalseSkip waiting for results, only trigger the scan(flag only)

Execution Time Considerations

⏱️ Performance Options:
  • With result waiting (default): ~7 minutes
    • Triggers scan and waits for complete analysis results
    • Includes both security and SCA (Software Composition Analysis) results
    • Best for comprehensive CI/CD pipelines where you need immediate feedback
  • With --no-wait flag: ~2 minutes
    • Only triggers the scan and returns immediately
    • Results can be fetched later or viewed in the CodeAnt dashboard
    • Ideal for faster CI runs or when results can be processed asynchronously

Example Configurations

Fast CI Mode (No Wait)

scan_codeant_fast:
  stage: scan
  image: python:3.11
  script:
    - export API_BASE="https://api.codeant.ai"
    - curl -sS -X GET "${API_BASE}/analysis/ci/scan/script/get" \
        --output start_scan.sh.b64
    - base64 -d start_scan.sh.b64 > start_scan.sh
    - chmod +x start_scan.sh
    - bash start_scan.sh \
        -a "$ACCESS_TOKEN" \
        -r "$CI_PROJECT_PATH" \
        -c "$CI_COMMIT_SHA" \
        -s gitlab \
        -n  # Returns in ~2 minutes

Comprehensive Analysis (Wait for Results)

scan_codeant_full:
  stage: scan
  image: python:3.11
  script:
    - export API_BASE="https://api.codeant.ai"
    - curl -sS -X GET "${API_BASE}/analysis/ci/scan/script/get" \
        --output start_scan.sh.b64
    - base64 -d start_scan.sh.b64 > start_scan.sh
    - chmod +x start_scan.sh
    - bash start_scan.sh \
        -a "$ACCESS_TOKEN" \
        -r "$CI_PROJECT_PATH" \
        -c "$CI_COMMIT_SHA" \
        -s gitlab \
        -b "$CI_COMMIT_REF_NAME" \
        -p 20 \
        -t 600  # Wait up to 10 minutes

Custom File Filtering

scan_codeant_custom:
  stage: scan
  image: python:3.11
  script:
    - export API_BASE="https://api.codeant.ai"
    - curl -sS -X GET "${API_BASE}/analysis/ci/scan/script/get" \
        --output start_scan.sh.b64
    - base64 -d start_scan.sh.b64 > start_scan.sh
    - chmod +x start_scan.sh
    - bash start_scan.sh \
        -a "$ACCESS_TOKEN" \
        -r "$CI_PROJECT_PATH" \
        -c "$CI_COMMIT_SHA" \
        -s gitlab \
        -i "src/**/*.{js,ts}" \
        -e "**/node_modules/**,**/dist/**" \
        -n
Tips:
  • Add an ACCESS_TOKEN variable in Settings → CI/CD → Variables (mark as protected and masked)
  • Use --no-wait for PR checks to keep them fast, and full analysis for main branch merges
  • Adjust timeout based on your repository size - larger repos may need more time
  • File patterns support standard glob syntax for precise control over what gets analyzed

How it works

  1. Download script We fetch a small Bash helper (start_scan.sh) from the CodeAnt CI endpoint.
  2. Make it runnable Mark the script executable so you can invoke it directly.
  3. Invoke the scan The script POSTs your repo, commit, and file-globs to /analysis/ci/scan, using your token for auth.
  4. Pipeline feedback
    • On success, you’ll see a parsed JSON response in the job log.
    • On failure (non-2xx HTTP), the script exits non-zero, failing your pipeline immediately.
With this in place, every push will automatically kick off a CodeAnt analysis run—and your CI status will reflect whether any HIGH-severity issues were detected.