Köra linting och enhetstestning

  • 6 minuter

GitHub Actions kan användas för att automatisera uppgifter som utlöses av händelser. Om du vill utlösa kodkvalitetskontroller när en pull-begäran skapas måste du:

  • Verifiera koden med linters och enhetstester.
  • Integrera kodkontroller med pull-begäranden.

Verifiera koden

Det finns två vanliga typer av kontroller som du vill göra på koden: linters och enhetstester.

Du kan använda linters för att kontrollera om koden följer de kvalitetsriktlinjer som din organisation har angett. Om du till exempel vill skicka koden med Flake8 skapar du en .flake8 konfigurationsfil som innehåller de regler som koden måste följa.

Om du vill kontrollera om koden fungerar som förväntat kan du skapa enhetstester. För att enkelt testa specifika delar av koden bör skripten innehålla funktioner. Du kan testa funktioner i skripten genom att skapa testfiler. Ett populärt verktyg för att testa Python-kod är Pytest.

Dricks

Läs mer om hur du kör enhetstester med Pytest.

Om du vill kontrollera koden med hjälp av GitHub Actions måste du:

  • Installera verktyget (Flake8 eller Pytest).
  • Kör testerna genom att ange de mappar i lagringsplatsen som måste kontrolleras.

Dricks

Du kan verifiera kod automatiskt med GitHub Actions eller manuellt i Visual Studio Code. Läs mer om hur du verifierar koden lokalt.

Integrera kodkontroller med pull-begäranden.

Om du vill utlösa ett GitHub Actions-arbetsflöde när en pull-begäran skapas kan du använda on: pull_request.

Du vill se till att en pull-begäran endast kan sammanfogas när alla kvalitetskontroller har godkänts.

Om du vill integrera kodkontrollerna med alla pull-begäranden som riktar sig mot huvudgrenen måste du göra följande:

  1. Gå till fliken Inställningar på lagringsplatsen.
  2. Välj Grenar.
  3. Aktivera kräv att statuskontroller skickas innan de slås samman i grenskyddsregeln för huvudgrenen.

Skärmbild av inställningen för att kräva statuskontroller innan sammanslagning.

Här kan du söka efter och välja dina linters- och enhetstester för att ange dem efter behov. När du sedan skapar en pull-begäran kommer du att märka att den utlöser dina GitHub Actions och endast när arbetsflödena skickas kommer du att kunna slå samman pull-begäran.

Kommentar

För att konfigurera de kodkontroller som krävs innan du sammanfogar en pull-begäran måste ditt jobb ha ett namn i GitHub Actions-arbetsflödet. Du kan sedan hitta kontrollerna genom att söka efter jobbnamnen.