Linting en eenheidstests uitvoeren

  • 6 minuten

GitHub Actions kan worden gebruikt om taken te automatiseren die worden geactiveerd door gebeurtenissen. Als u codekwaliteitscontroles wilt activeren wanneer een pull-aanvraag wordt gemaakt, moet u het volgende doen:

  • Controleer uw code met linters en eenheidstests.
  • Codecontroles integreren met pull-aanvragen.

Uw code verifiëren

Er zijn twee veelvoorkomende typen controles die u wilt uitvoeren voor uw code: linters en eenheidstests.

U kunt linters gebruiken om te controleren of uw code voldoet aan de kwaliteitsrichtlijnen die uw organisatie heeft ingesteld. Als u bijvoorbeeld uw code wilt linten met Flake8, maakt u een .flake8 configuratiebestand dat de regels bevat waaraan uw code moet voldoen.

Als u wilt controleren of de code werkt zoals verwacht, kunt u eenheidstests maken. Als u eenvoudig specifieke onderdelen van uw code wilt testen, moeten uw scripts functies bevatten. U kunt functies in uw scripts testen door testbestanden te maken. Een populair hulpprogramma om Python-code te testen, is Pytest.

Tip

Meer informatie over het uitvoeren van eenheidstests met Pytest.

Als u uw code wilt controleren met behulp van GitHub Actions, moet u het volgende doen:

  • Installeer het hulpprogramma (Flake8 of Pytest).
  • Voer de tests uit door de mappen in uw opslagplaats op te geven die moeten worden gecontroleerd.

Tip

U kunt code automatisch verifiëren met GitHub Actions of handmatig in Visual Studio Code. Meer informatie over het lokaal verifiëren van uw code.

Codecontroles integreren met pull-aanvragen.

Als u een GitHub Actions-werkstroom wilt activeren wanneer een pull-aanvraag wordt gemaakt, kunt u dit gebruiken on: pull_request.

U wilt ervoor zorgen dat een pull-aanvraag alleen kan worden samengevoegd wanneer alle kwaliteitscontroles zijn geslaagd.

Als u de codecontroles wilt integreren met pull-aanvragen die gericht zijn op de hoofdbranch, moet u het volgende doen:

  1. Navigeer naar het tabblad Instellingen in uw opslagplaats.
  2. Selecteer Vertakkingen.
  3. Schakel statuscontroles in om door te geven voordat de vertakkingsbeveiligingsregel voor de hoofdbranch wordt samengevoegd.

Schermopname van het instellen om statuscontroles te vereisen voordat u samenvoegt.

Hier kunt u uw linters en eenheidstests doorzoeken en selecteren om ze naar behoefte in te stellen. Wanneer u vervolgens een pull-aanvraag maakt, zult u merken dat uw GitHub Actions worden geactiveerd en alleen wanneer de werkstromen zijn geslaagd, kunt u de pull-aanvraag samenvoegen.

Notitie

Als u de codecontroles wilt configureren die vereist zijn voordat u een pull-aanvraag samenvoegt, moet uw taak een naam hebben in de GitHub Actions-werkstroom. Vervolgens kunt u de controles vinden door te zoeken naar de taaknamen.