Ausführen von Lint- und Komponententests
GitHub Actions kann verwendet werden, um Aufgaben zu automatisieren, die durch Ereignisse ausgelöst werden. Um Codequalitätsprüfungen auszulösen, wenn ein Pull Request erstellt wird, müssen Sie die folgenden Aufgaben ausführen:
- Überprüfen von Code mit Lintern und Komponententests
- Integrieren von Codeüberprüfungen mit Pull Requests
Überprüfen des Codes
Es gibt zwei gängige Arten von Überprüfungen für Ihren Code: Linter und Komponententests.
Sie können Linter verwenden, um zu überprüfen, ob Ihr Code den festgelegten Qualitätsrichtlinien Ihrer Organisation entspricht. Für das Linten Ihres Codes mit Flake8 erstellen Sie beispielsweise eine .flake8-Konfigurationsdatei, die die Regeln enthält, die Ihr Code einhalten muss.
Um zu überprüfen, ob der Code wie erwartet funktioniert, können Sie Komponententests erstellen. Zum einfachen Testen bestimmter Teile des Codes sollten Ihre Skripts Funktionen enthalten. Sie können Funktionen in Ihren Skripts testen, indem Sie Testdateien erstellen. Ein beliebtes Tool zum Testen von Python-Code ist Pytest.
Tipp
Informieren Sie sich weiter über das Ausführen von Komponententests mit Pytest.
Führen Sie die folgenden Schritte aus, um Ihren Code mithilfe von GitHub Actions zu überprüfen:
- Installieren Sie das Tool (Flake8 oder Pytest).
- Führen Sie die Tests aus, indem Sie die Ordner in Ihrem Repository angeben, die überprüft werden müssen.
Tipp
Sie können Code automatisch mit GitHub Actions oder manuell in Visual Studio Code überprüfen. Informieren Sie sich, wie Sie Code lokal überprüfen können.
Integrieren von Codeüberprüfungen mit Pull Requests
Sie können on: pull_request verwenden, um einen GitHub Actions-Workflow auszulösen, wenn ein Pull Request erstellt wird.
Sie möchten sicherstellen, dass ein Pull Request nur gemergt werden kann, wenn alle Qualitätsprüfungen bestanden wurden.
Um die Codeüberprüfungen mit Pull Requests zu integrieren, die den Mainbranch als Ziel haben, müssen Sie die folgenden Schritte ausführen:
- Navigieren Sie in Ihrem Repository zur Registerkarte Einstellungen.
- Wählen Sie Branches aus.
- Aktivieren Sie Require status checks to pass before merging (Erfordern, dass Statusprüfungen vor dem Mergen bestanden werden) in der Branchschutzregel für den Mainbranch.
Hier können Sie Ihre Linter und Komponententests suchen und auswählen, um sie nach Bedarf festzulegen. Wenn Sie dann einen Pull Request erstellen, werden Sie feststellen, dass dieser Ihre GitHub Actions-Aktion auslöst und Sie ihn nur bei erfolgreicher Ausführung der Workflows mergen können.
Hinweis
Um die Codeüberprüfungen zu konfigurieren, die vor dem Mergen eines Pull Requests erforderlich sind, muss Ihr Auftrag einen Namen im GitHub Actions-Workflow haben. Sie können die Überprüfungen dann über die Auftragsnamen suchen.