Een werkstroom activeren
Niemand mag wijzigingen rechtstreeks naar de hoofdbranch in uw codeopslagplaats pushen. In het ideale geval moet u, indien nodig, wijzigingen aanbrengen in een kopie van de code in een vertakking.
Een algemene benadering is het werken met functiebranches, waarbij een vertakking wordt gebruikt om aan een functie te werken. Het data science-team moet bijvoorbeeld de modelprestaties verbeteren en dit proberen door te experimenteren met hyperparameterwaarden. Het team kan een vertakking maken, de hyperparameterwaarde bijwerken in het trainingsscript. En eenmaal gedaan met experimenteren, kan een data scientist een pull-aanvraag maken om de vertakking samen te voegen met de hoofdopslagplaats.
Als u met vertakkingen en pull-aanvragen werkt, kunt u eventuele wijzigingen in uw code controleren voordat u ze samenvoegt met de hoofdbranch. Pull-aanvragen kunnen ook worden gebruikt als trigger voor GitHub Actions om taken te automatiseren die een voorgestelde update van de code moeten volgen, zoals automatische controle van codekwaliteit.
Als u op functies gebaseerde ontwikkeling wilt gebruiken in combinatie met automatisering, moet u het volgende doen:
- Maak een vertakkingsbeveiligingsregel om directe pushes naar de hoofdmap te blokkeren.
- Maak een vertakking om de code bij te werken.
- Een GitHub Actions-werkstroom activeren bij het openen van een pull-aanvraag.
Een vertakkingsbeveiligingsregel maken
Als u uw code wilt beveiligen, wilt u eventuele directe pushes naar de hoofdbranch blokkeren. Het blokkeren van directe pushes betekent dat niemand rechtstreeks codewijzigingen naar de hoofdbranch mag pushen. In plaats daarvan kunnen wijzigingen in de hoofdbranch worden aangebracht door pull-aanvragen samen te voegen.
Als u de hoofdbranch wilt beveiligen, schakelt u een vertakkingsbeveiligingsregel in gitHub in:
- Navigeer naar het tabblad Instellingen in uw opslagplaats.
- Selecteer Vertakkingen op het tabblad Instellingen onder Code en automatisering.
- Selecteer Regel toevoegen.
- Voer
main
onder Branch name pattern in. - Schakel Een pull-aanvraag vereisen in voordat u samenvoegt en goedkeuringen vereisen.
- Sla uw wijzigingen op.
Maak een vertakking om de code bij te werken.
Wanneer u de code wilt bewerken, moet u daar een vertakking maken en daar werken. Zodra u de wijzigingen definitief wilt aanbrengen, kunt u een pull-aanvraag maken om de functiebranch samen te voegen met de hoofdbranch.
Tip
Meer informatie over broncodebeheer voor machine learning-projecten en het werken met op functies gebaseerde ontwikkeling.
Een GitHub Actions-werkstroom activeren
Ten slotte kunt u het maken van pull-aanvragen gebruiken als trigger voor GitHub Actions-werkstromen. Wanneer iemand bijvoorbeeld wijzigingen aanbrengt in de code, moet u enkele kwaliteitscontroles voor code uitvoeren.
Alleen wanneer de bewerkte code de kwaliteitscontroles heeft doorstaan en iemand de voorgestelde wijzigingen heeft geverifieerd, wilt u de pull-aanvraag daadwerkelijk samenvoegen.
Als u een GitHub Actions-werkstroom wilt activeren, kunt u dit gebruiken on: [pull_request]
. Wanneer u deze trigger gebruikt, wordt uw werkstroom uitgevoerd wanneer de pull-aanvraag wordt gemaakt.
Als u wilt dat een werkstroom wordt uitgevoerd wanneer een pull-aanvraag wordt samengevoegd, moet u een andere trigger gebruiken. Het samenvoegen van een pull-aanvraag is in feite een push naar de hoofdbranch. Als u dus een werkstroom wilt activeren die moet worden uitgevoerd wanneer een pull-aanvraag wordt samengevoegd, gebruikt u de volgende trigger in de GitHub Actions-werkstroom:
on:
push:
branches:
- main