Configuration de la couverture du code pour votre référentiel

Vous pouvez configurer la couverture du code pour votre dépôt de deux manières :

• Configuration automatique : Utilisez l’agent alimenté par l’IA pour générer automatiquement un flux de travail. Choisissez cette option si :
  • Vous souhaitez commencer rapidement sans écrire de configuration YAML.
  • Votre projet utilise des frameworks de test courants et des modèles de génération.
  • Vous êtes à l’aise lors d’une itération sur un flux de travail généré par l’IA.
• Configuration manuelle : Configurez votre flux de travail CI vous-même. Choisissez cette option si :
  • Vous avez besoin d’un contrôle précis sur le processus de couverture.
  • Vous avez des exigences ci complexes (telles que des registres privés ou des étapes de génération personnalisées).
  • Vous souhaitez comprendre exactement la façon dont la couverture est configurée.

Configuration automatique

Vous pouvez utiliser l’option de configuration automatique pour générer un flux de travail de couverture du code de travail sans créer manuellement la configuration CI. Un agent analyse votre référentiel, identifie votre infrastructure de test et ouvre une demande de tirage avec un flux de travail de couverture prêt à être examiné.

Conditions préalables pour l’installation automatique

• Code Quality est activé pour votre référentiel. Consultez « Activation de GitHub Code Quality ».
• Votre référentiel dispose d’une suite de tests existante.

Génération automatique d’un flux de travail de couverture

1. Sur GitHub, accédez à la page principale du référentiel.

2. Sous le nom de votre référentiel, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

   

3. Dans la barre latérale, sous « Sécurité », cliquez Qualité du code pour afficher la page «Qualité du code ».

4. Dans la section « Analyse de la couverture du code », cliquez sur la zone de liste déroulante Configuration .

5. Dans la liste, sélectionnez Générer un flux de travail avec l’IA. Attendez que l’agent analyse votre dépôt. L’agent ouvre un brouillon de demande de tirage et publie une liste de contrôle des étapes à suivre.

6. Pour passer en revue la demande de tirage, cliquez sur Vérifier la demande de tirage. Passez en revue la demande de tirage une fois que l’agent a terminé son travail. La description de la demande de tirage récapitule les modifications, y compris les mises à jour de configuration du projet, les modifications apportées aux fichiers de flux de travail et les paramètres de sortie de couverture.

7. Si le flux de travail s’exécute correctement dans CI et que la couverture se charge correctement, fusionnez la demande de tirage.

   Si le flux de travail a besoin d’ajustements, consultez Configuration de la couverture automatique du code pour obtenir des conseils sur les différents résultats et sur la façon d’itérer.

Pour plus d’informations sur le fonctionnement de l’agent et les attentes, consultez Configuration de la couverture automatique du code.

Installation manuelle

La couverture du code intégrée vous permet de suivre la manière dont vos tests exercicent votre code, sans ajouter un service tiers à votre chaîne d’outils ou à votre budget. Dans les procédures suivantes, vous allez générer un rapport de couverture XML Cobertura à partir de votre suite de tests, le téléverser vers GitHub, puis consulter les résultats de couverture sur vos pull requests.

Conditions préalables pour la configuration manuelle

• Code Quality est activé pour votre référentiel.
• Votre référentiel a une suite de tests qui s’exécute dans GitHub Actions.
• Votre infrastructure de test peut produire un rapport de couverture au format XML Cobertura .

Étape 1 : Générer un rapport de couverture XML Cobertura

Configurez votre infrastructure de test pour générer un rapport de couverture au format XML Cobertura. La couverture du code fonctionne avec n’importe quel langage de programmation qui peut produire ce format.

1. Identifiez l’outil de couverture de votre langue dans le tableau ci-dessous.
2. Ajoutez la commande ou la configuration appropriée à votre flux de travail CI afin qu’un fichier XML Cobertura soit généré chaque fois que vos tests s’exécutent.

Étape 2 : Charger le rapport de couverture

Une fois que vos tests ont généré un rapport XML Cobertura, téléversez-le sur GitHub afin que les résultats de couverture s’affichent sur les demandes de fusion.

1. Ouvrez le fichier de flux de travail CI de votre référentiel (par exemple). .github/workflows/ci.yml

2. Ajoutez l’étape suivante après l’étape qui exécute vos tests et génère le rapport de couverture :

   YAML

   - name: Upload coverage report
     if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
     uses: actions/upload-code-coverage@v1
     with:
       file: COVERAGE-FILE-PATH.xml
       language: LANGUAGE
       label: LABEL
   

3. Remplacez les valeurs suivantes :

   • COVERAGE-FILE-PATH.xml: chemin d’accès à votre rapport XML Cobertura (par exemple, coverage.xml ou target/site/jacoco/cobertura.xml).
   • LANGUAGE : langage principal du code couvert (par exemple, Python, Java, JavaScript).
   • LABEL: étiquette facultative pour identifier ce rapport de couverture (par exemple, code-coverage/pytest).

4. Effectuez un commit et poussez la modification du flux de travail.

Exemple de flux de travail complet

Cet exemple exécute Python tests avec pytest-cov et charge le rapport de couverture :

# This workflow runs your test suite, generates a Cobertura XML coverage report, and uploads it to GitHub. Once this workflow is committed, coverage results appear automatically on every pull request.
name: Code Coverage

# Run on pushes to the default branch (to establish the baseline) and on pull requests (to compare against it). Code Quality compares PR branch coverage to the default branch, so both triggers are needed.
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

# The `code-quality: write` permission is required to upload coverage data. No other elevated permissions are needed.
permissions:
  contents: read
  code-quality: write

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      # Check out the PR head commit (not the merge commit) so coverage line numbers map correctly to the diff.
      - uses: actions/checkout@v6
        with:
          ref: ${{ github.event.pull_request.head.sha || github.sha }}

      # Replace this step with whatever language setup your project uses (Node.js, Java, Go, etc.). The upload action works with any language that produces a Cobertura XML report.
      - uses: actions/setup-python@v5
        with:
          python-version: "3.x"

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          pip install pytest pytest-cov

      # Adapt this step for your test framework. The key requirement is producing a Cobertura XML file. For other languages, see the framework table earlier in this article.
      - name: Run tests with coverage
        run: pytest --cov=. --cov-report=xml

      # This step replaces any third-party coverage upload (Codecov, Coveralls, etc.). After this runs, the `github-code-quality[bot]` bot posts a coverage summary directly on the pull request.
      - name: Upload coverage report
        if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
        uses: actions/upload-code-coverage@v1
        with:
          file: coverage.xml
          language: Python
          label: code-coverage/pytest

name: Code Coverage

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

permissions:
  contents: read
  code-quality: write
jobs:
  test:
    runs-on: ubuntu-latest
    steps:

      - uses: actions/checkout@v6
        with:
          ref: ${{ github.event.pull_request.head.sha || github.sha }}

      - uses: actions/setup-python@v5
        with:
          python-version: "3.x"
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          pip install pytest pytest-cov

      - name: Run tests with coverage
        run: pytest --cov=. --cov-report=xml

      - name: Upload coverage report
        if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
        uses: actions/upload-code-coverage@v1
        with:
          file: coverage.xml
          language: Python
          label: code-coverage/pytest

# This workflow runs your test suite, generates a Cobertura XML coverage report, and uploads it to GitHub. Once this workflow is committed, coverage results appear automatically on every pull request.
name: Code Coverage

# Run on pushes to the default branch (to establish the baseline) and on pull requests (to compare against it). Code Quality compares PR branch coverage to the default branch, so both triggers are needed.
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

# The `code-quality: write` permission is required to upload coverage data. No other elevated permissions are needed.
permissions:
  contents: read
  code-quality: write

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      # Check out the PR head commit (not the merge commit) so coverage line numbers map correctly to the diff.
      - uses: actions/checkout@v6
        with:
          ref: ${{ github.event.pull_request.head.sha || github.sha }}

      # Replace this step with whatever language setup your project uses (Node.js, Java, Go, etc.). The upload action works with any language that produces a Cobertura XML report.
      - uses: actions/setup-python@v5
        with:
          python-version: "3.x"

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          pip install pytest pytest-cov

      # Adapt this step for your test framework. The key requirement is producing a Cobertura XML file. For other languages, see the framework table earlier in this article.
      - name: Run tests with coverage
        run: pytest --cov=. --cov-report=xml

      # This step replaces any third-party coverage upload (Codecov, Coveralls, etc.). After this runs, the `github-code-quality[bot]` bot posts a coverage summary directly on the pull request.
      - name: Upload coverage report
        if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
        uses: actions/upload-code-coverage@v1
        with:
          file: coverage.xml
          language: Python
          label: code-coverage/pytest

Étape 3 : Afficher les résultats de couverture sur les pull requests

1. Ouvrez une pull request (ou ajoutez des commits à une pull request existante) qui déclenche le workflow que vous avez configuré.
2. Une fois le workflow terminé, recherchez un commentaire de github-code-quality[bot] sur la pull request. Le commentaire comprend :
   • Le pourcentage de couverture agrégé de la branche de la pull request par rapport à la branche par défaut.
   • Répartition par fichier montrant quels fichiers ont gagné ou perdu la couverture.

Étapes suivantes

• Interprétez les résultats : Comprenez les indicateurs de couverture et le détail fichier par fichier dans vos pull requests. Consultez « Interprétation des résultats de qualité du code pour votre référentiel ».
• Appliquer les seuils de couverture : Bloquer les demandes de tirage qui ne répondent pas à un pourcentage minimal de couverture ou qui entraînent la suppression de la couverture. Consultez « Définir des seuils de couverture du code pour les pull requests ».