Uruchamianie lintingu i testowania jednostkowego
Funkcja GitHub Actions może służyć do automatyzowania zadań wyzwalanych przez zdarzenia. Aby wyzwolić sprawdzanie jakości kodu po utworzeniu żądania ściągnięcia, należy wykonać następujące kroki:
- Zweryfikuj kod za pomocą linterów i testów jednostkowych.
- Integrowanie kontroli kodu z żądaniami ściągnięcia.
Weryfikowanie kodu
Istnieją dwa typowe typy testów, które należy wykonać w kodzie: linters i testy jednostkowe.
Możesz użyć linters , aby sprawdzić, czy kod jest zgodny z wytycznymi dotyczącymi jakości ustawionymi przez organizację. Na przykład aby utworzyć kod lint za pomocą platformy Flake8, utworzysz .flake8 plik konfiguracji zawierający reguły, z którymi musi być zgodny kod.
Aby sprawdzić, czy kod działa zgodnie z oczekiwaniami, możesz utworzyć testy jednostkowe. Aby łatwo przetestować określone części kodu, skrypty powinny zawierać funkcje. Funkcje można testować w skryptach, tworząc pliki testowe. Popularnym narzędziem do testowania kodu w języku Python jest Pytest.
Napiwek
Dowiedz się więcej na temat uruchamiania testów jednostkowych za pomocą narzędzia Pytest.
Aby sprawdzić kod przy użyciu funkcji GitHub Actions, musisz wykonać następujące czynności:
- Zainstaluj narzędzie (Flake8 lub Pytest).
- Uruchom testy, określając foldery w repozytorium, które należy sprawdzić.
Napiwek
Kod można zweryfikować automatycznie za pomocą funkcji GitHub Actions lub ręcznie w programie Visual Studio Code. Dowiedz się więcej o sposobie weryfikowania kodu lokalnie.
Integrowanie kontroli kodu z żądaniami ściągnięcia.
Aby wyzwolić przepływ pracy funkcji GitHub Actions po utworzeniu żądania ściągnięcia, możesz użyć polecenia on: pull_request.
Chcesz upewnić się, że żądanie ściągnięcia może zostać scalone tylko po zakończeniu wszystkich kontroli jakości.
Aby zintegrować testy kodu z dowolnymi żądaniami ściągnięcia przeznaczonymi dla gałęzi głównej, należy wykonać następujące czynności:
- Przejdź do karty Ustawienia w repozytorium.
- Wybierz pozycję Gałęzie.
- Włącz wymagaj, aby testy stanu przeszły przed scaleniem w regule ochrony gałęzi dla głównej gałęzi.
W tym miejscu możesz wyszukać i wybrać linters oraz testy jednostkowe, aby ustawić je zgodnie z potrzebami. Za każdym razem, gdy utworzysz żądanie ściągnięcia, zauważysz, że spowoduje to wyzwolenie funkcji GitHub Actions i tylko wtedy, gdy przepływy pracy zostaną pomyślnie przekazane, będzie można scalić żądanie ściągnięcia.
Uwaga
Aby skonfigurować sprawdzanie kodu, które mają być wymagane przed scaleniem żądania ściągnięcia, zadanie musi mieć nazwę w przepływie pracy funkcji GitHub Actions. Następnie możesz znaleźć testy, wyszukując nazwy zadań.