Spuštění lintingu a testování jednotek

  • 6 min

GitHub Actions se dá použít k automatizaci úloh aktivovaných událostmi. Pokud chcete při vytváření žádosti o přijetí změn aktivovat kontroly kvality kódu, budete muset:

  • Ověřte kód pomocí linterů a testů jednotek.
  • Integrace kontrol kódu s žádostmi o přijetí změn

Ověření kódu

Existují dva běžné typy kontrol, které budete chtít provést v kódu: lintery a testy jednotek.

Pomocí linterů můžete zkontrolovat, jestli váš kód dodržuje pokyny pro zvýšení kvality, které vaše organizace nastavila. Například pro lintování kódu pomocí Flake8 vytvoříte .flake8 konfigurační soubor, který obsahuje pravidla, která musí váš kód dodržovat.

Pokud chcete zkontrolovat, jestli kód funguje podle očekávání, můžete vytvořit testy jednotek. Abyste mohli snadno testovat konkrétní části kódu, měly by skripty obsahovat funkce. Funkce ve skriptech můžete testovat vytvořením testovacích souborů. Oblíbeným nástrojem pro testování kódu Pythonu je Pytest.

Tip

Přečtěte si další informace o tom, jak spouštět testy jednotek pomocí Pytestu.

Pokud chcete zkontrolovat kód pomocí GitHub Actions, budete muset:

  • Nainstalujte nástroj (Flake8 nebo Pytest).
  • Testy spusťte zadáním složek v úložišti, které je potřeba zkontrolovat.

Tip

Kód můžete automaticky ověřit pomocí GitHub Actions nebo ručně v editoru Visual Studio Code. Přečtěte si další informace o tom, jak ověřit kód místně.

Integrace kontrol kódu s žádostmi o přijetí změn

Pokud chcete při vytváření žádosti o přijetí změn aktivovat pracovní postup GitHub Actions, můžete použít on: pull_request.

Chcete zajistit, aby žádost o přijetí změn byla sloučena pouze v případech, kdy byly splněny všechny kontroly kvality.

Pokud chcete integrovat kontroly kódu se všemi žádostmi o přijetí změn, které cílí na hlavní větev, musíte provést následující kroky:

  1. V úložišti přejděte na kartu Nastavení.
  2. Vyberte větve.
  3. Před sloučením v pravidle ochrany větve pro hlavní větev povolte kontroly stavu.

Screenshot of setting to require status checks before merging.

Tady můžete vyhledávat a vybírat lintery a testy jednotek a nastavit je podle potřeby. Když pak vytvoříte žádost o přijetí změn, všimnete si, že aktivuje GitHub Actions a teprve když pracovní postupy úspěšně projdou, budete moct žádost o přijetí změn sloučit.

Poznámka:

Pokud chcete nakonfigurovat kontroly kódu, které se mají vyžadovat před sloučením žádosti o přijetí změn, musí mít vaše úloha název v pracovním postupu GitHub Actions. Kontroly pak můžete najít vyhledáním názvů úloh.