Jenkinsfile Checkout SCM

Das Quellcodemanagement oder das SCM bezieht sich auf das Versionskontrollsystem (VCS), mit dem der Quellcode eines Projekts verwaltet wird. Jenkins unterstützt mehrere SCM -Systeme wie Git, Subversion, Quecksilber und viele andere.

Während der Projektkonfiguration können wir das SCM -Repository angeben, in dem der Quellcode für das Projekt gespeichert ist. Jenkins überprüft dann regelmäßig das Repository auf Änderungen. Wenn neue Commits oder Updates erkannt werden, löst es automatisch einen Projektbau aus.

In einer Jenkins -Datei können wir den SCM -Schritt Checkout -Schritt definieren, um den Quellcode für die Pipeline aus dem angegebenen SCM -Repository abzurufen. Dieser Schritt ist normalerweise der erste Schritt in einer JenkinsFile, um sicherzustellen, dass der Quellcode für den Rest der Pipeline verfügbar ist.

Jenkins SCM Step Plugin

Mit dem Jenkins SCM Step -Plugin können die Jenkins -Pipelines die Standard -Jenkins -SCM -Plugins verwenden, um den Quellcode von einer SCM -Quelle zu überprüfen. Dies bietet erweiterbare Checkout -Optionen, die die verschiedenen SCM -Quellen, spezifischen Zweige und mehr angeben.

Um dieses Plugin zu verwenden, müssen Sie es auf Ihrem Jenkins -Controller installieren. Öffnen Sie das Jenkins Dashboard und wählen Sie im linken Menü "Jenkins verwalten". Navigieren Sie zur Seite "Plugins verwalten" -> verfügbare Plugins und suchen Sie nach "SCM -Schritt".

Verwenden Sie den Jenkins SCM -Schritt

Sobald wir das SCM -Plugin installiert haben, können wir das Checkout -SCM -Plugin wie in der folgenden Pipeline -Beispiel verwenden:

Pipeline
Agent Label 'My-Agent'
Stufen
Stage ('Build')
Schritte
Checkout SCM
sh machen

Im vorherigen Beispiel verwenden wir den Checkout -SCM -Schritt, um die Quelle zu überprüfen und den Build mit dem Befehl machen.

Sie können die verschiedenen SCM -Quellen wie AWS -Code -Pipeline, Bazaar SCM, Bitkeeper, Mercuria, Open Shift -Bilder, Dateisystem und mehr angeben.

Das folgende Bild zeigt die akzeptierten SCM -Quellen für den Checkout -Schritt:

Quelle: Jenkins SCM -Dokumentation.

Das folgende Beispiel zeigt, wie Sie die SCM -Quelle und andere Optionen wie die Anmeldeinformationen angeben können:

Checkout SCM: [$ class: 'mercurialscm', Quelle: 'ssh: // [email protected]/user/repo ', sauber: true, credentialssid:' 1234-5678-ABCD '], Umfrage: Falsch

Im vorherigen Beispiel gibt der Checkout -SCM -Block SCM an, aus dem der Checkout -Schritt den Quellcode erhält.

Wir definieren auch die Konfiguration für das Ziel -SCM einschließlich der URL und der Anmeldeinformationen für den Server.

In diesem Fall wird die [$ class: 'mercurialScm'] mithilfe des Mercurial SCM definiert, um eine Verbindung zum Repository herzustellen.

Als Nächst.

Wir definieren auch die saubere Option, die Jenkins aufweist, eine "saubere" Kasse durchzuführen. Auf diese Weise können Jenkins alle lokalen Änderungen verwerfen und eine neue Kopie des Repositorys ansehen.

Die Option "Anmeldeinformationen.

Schließlich ist die Optionsumfrage auf false eingestellt. Dies verhindert, dass Jenkins das Repository für Änderungen befragt. Daher löst Jenkins nicht automatisch einen Build aus, wenn neue Commits oder Updates im Repository erkannt werden. Wir müssen einen Build manuell auslösen oder andere Mittel (z. B. ein Webhook) verwenden, um einen Build auszulösen.

Abschluss

Wir haben die Grundlagen der Verwendung des SCM -Checkout -Schritts in Jenkins untersucht, um den Quellcode von einem bestimmten Repository zu überprüfen.