Exécution de l’analyse du code CodeQL dans un conteneur

Vous pouvez exécuter code scanning dans un conteneur en veillant à ce que tous les processus s’exécutent dans le même conteneur.

Qui peut utiliser cette fonctionnalité ?

Code scanning est disponible pour tous les types de référentiels suivants :

  • Des référentiels publics sur GitHub.com
  • Référentiels appartenant à l’organisation sur GitHub Enterprise Cloud avec GitHub Advanced Security activé

Dans cet article

À propos de l’code scanning avec une build conteneurisée

Si vous configurez l’code scanning pour un langage compilé et que vous générez le code dans un environnement conteneurisé, l’analyse peut échouer avec le message d’erreur « Aucun code source n’a été vu pendant la génération ». Cela indique que CodeQL n’a pas pu superviser votre code lors de sa compilation.

Vous devez exécuter CodeQL dans le conteneur dans lequel vous générez votre code. Cela s’applique que vous utilisiez CodeQL CLI ou GitHub Actions. Pour obtenir la CodeQL CLI, consultez « Utilisation de l'analyse du code avec votre système CI existant » pour plus d’informations. Si vous utilisez GitHub Actions, configurez votre workflow pour exécuter toutes les actions dans le même conteneur. Pour plus d’informations, consultez « Exemple de workflow ».

Note

CodeQL CLI n’est actuellement pas compatible avec les distributions Linux non-glibc comme Alpine Linux (basée sur musl).

Dépendances pour CodeQL code scanning

Vous pouvez avoir des difficultés à exécuter une code scanning si le conteneur que vous utilisez n’a pas certaines dépendances (par exemple, Git doit être installé et ajouté à la variable PATH). Si vous rencontrez des problèmes de dépendance, consultez la liste des logiciels généralement inclus dans les images d’exécuteur de GitHub. Pour plus d’informations, consultez les fichiers readme spécifiques à la version dans ces emplacements :

Exemple de flux de travail

Cet exemple de workflow utilise GitHub Actions pour exécuter l’analyse CodeQL dans un environnement conteneurisé. La valeur de container.image identifie le conteneur à utiliser. Dans cet exemple, l’image est nommée codeql-container et porte l’étiquette f0f91db. Pour plus d’informations, consultez « Workflow syntax for GitHub Actions ».

name: "CodeQL"

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
  schedule:
    - cron: '15 5 * * 3'

jobs:
  analyze:
    name: Analyze
    runs-on: ubuntu-latest
    permissions:
      security-events: write
      actions: read

    strategy:
      fail-fast: false
      matrix:
        language: [java-kotlin]

    # Specify the container in which actions will run
    container:
      image: codeql-container:f0f91db

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Initialize CodeQL
        uses: github/codeql-action/init@v3
        with:
          languages: ${{ matrix.language }}
      - name: Build
        run: |
          ./configure
          make
      - name: Perform CodeQL Analysis
        uses: github/codeql-action/analyze@v3