Kør linting og enhedstest

  • 6 minutter

GitHub-handlinger kan bruges til at automatisere opgaver, der udløses af hændelser. Hvis du vil udløse kontrol af kodekvalitet, når der oprettes en pullanmodning, skal du:

  • Bekræft din kode med linters- og enhedstests.
  • Integrer kodekontroller med pullanmodninger.

Bekræft din kode

Der er to almindelige typer kontroller, du vil udføre på din kode: linters og enhedstest.

Du kan bruge linters til at kontrollere, om din kode overholder de retningslinjer for kvalitet, som din organisation har angivet. Hvis du f.eks. vil linte din kode med Flake8, skal du oprette en .flake8 konfigurationsfil, som indeholder de regler, som din kode skal overholde.

Hvis du vil kontrollere, om koden fungerer som forventet, kan du oprette enhedstest. Hvis du nemt vil teste bestemte dele af din kode, skal dine scripts indeholde funktioner. Du kan teste funktioner i dine scripts ved at oprette testfiler. Et populært værktøj til at teste Python-kode er Pytest.

Tip

Få mere at vide om , hvordan du kører enhedstest med Pytest.

Hvis du vil kontrollere din kode ved hjælp af GitHub-handlinger, skal du:

  • Installér værktøjet (Flake8 eller Pytest).
  • Kør testene ved at angive de mapper i lageret, der skal kontrolleres.

Tip

Du kan bekræfte kode automatisk med GitHub-handlinger eller manuelt i Visual Studio Code. Få mere at vide om , hvordan du bekræfter din kode lokalt.

Integrer kodekontroller med pullanmodninger.

Hvis du vil udløse en Arbejdsproces for GitHub-handlinger, når der oprettes en pullanmodning, kan du bruge on: pull_request.

Du vil sikre dig, at en pullanmodning kun kan flettes, når alle kvalitetskontroller er bestået.

Hvis du vil integrere kodetjek med pullanmodninger, der er målrettet til hovedgrenen, skal du gøre følgende:

  1. Gå til fanen indstillinger for i dit lager.
  2. Vælg forgreninger.
  3. Aktivér kræver, at statuskontroller overføres, før flettes i forgreningsbeskyttelsesreglen for hovedforgreningen.

Skærmbillede af indstilling, der kræver statuskontroller, før du fletter.

Her kan du søge efter og vælge dine linters- og enhedstest for at angive dem efter behov. Når du derefter opretter en pullanmodning, vil du bemærke, at den udløser dine GitHub-handlinger, og kun når arbejdsprocesserne overføres korrekt, kan du flette pullanmodningen.

Seddel

Hvis du vil konfigurere de kodekontroller, der skal kræves, før du fletter en pullanmodning, skal dit job have et navn i arbejdsprocessen for GitHub-handlinger. Du kan derefter finde kontrollerne ved at søge efter jobnavnene.