So erstellen Sie einen neuen Build-Auftrag in Jenkins Freestyle-Projekt

⚡ Intelligente Zusammenfassung

Jenkins Freestyle Project ist ein wiederholbarer Build-Job, der das Auschecken des Quellcodes, die Build-Schritte und die Aktionen nach dem Build in einer konfigurierbaren Aufgabe bündelt, die vollständig über die Plattform erstellt wird. Jenkins Webinterface ohne Pipeline-Code schreiben zu müssen.

  • 🔘 Definition: Ein Freestyle-Job ist Jenkins' allgemeiner Projekttyp, der über Formulare anstatt über ein JenkinsDatei.
  • ☑️ Voraussetzungen: Ein laufender Jenkins Zunächst werden ein Controller, ein JDK auf dem Build-Agent, das Git-Plugin und ein erreichbares Repository benötigt.
  • ✅ Zehn Schritte: Melden Sie sich an, erstellen Sie ein neues Element, benennen Sie es, legen Sie das Repository fest, fügen Sie einen Build-Schritt hinzu, speichern Sie, erstellen Sie das Element und lesen Sie die Konsolenausgabe.
  • 🧪 Ausgearbeitetes Beispiel: Ein von GitHub heruntergeladenes HelloWorld-Projekt lässt sich mit javac kompilieren und mit Java innerhalb einer Umgebung ausführen. Windows Batch-Build-Schritt.
  • ️ Konfigurationsdiagramm: Sechs Formularabschnitte – Allgemein, Quelle Code Management, Build-Trigger, Build-Umgebung, Build-Schritte und Nachbearbeitungsaktionen – alle Optionen sind abgedeckt.
  • ⚙️ Geltungsbereich: Freestyle-Jobs eignen sich für die Automatisierung einzelner Aufgaben; mehrstufige Auslieferungsprozesse gehören stattdessen in einen versionskontrollierten Pipeline-Job.

So erstellen Sie einen neuen Build-Auftrag in Jenkins Freestyle-Projekt

Non-Profit Jenkins Freestyle-Projekt?

Jenkins Freestyle-Projekt Ein Build-Job, ein Skript oder eine Pipeline, die Schritte und Aktionen nach dem Build enthält, ist wiederholbar. Es handelt sich um einen erweiterten Job oder eine Aufgabe, die sich über mehrere Operationen erstrecken kann. Sie ermöglicht die Konfiguration von Build-Triggern und bietet projektbasierte Sicherheit für Ihre Projekte. Jenkins Das Projekt bietet außerdem Plugins, die Ihnen beim Erstellen von Schritten und Nachbearbeitungsaktionen helfen.

Die Arten von Aktionen, die Sie in einem Jenkins Die Möglichkeiten für Build-Schritte oder Nachbearbeitungsaktionen sind recht begrenzt. Es gibt viele Standard-Plugins, die innerhalb eines solchen Plugins verfügbar sind. Jenkins Freestyle Project, um Ihnen bei der Bewältigung dieses Problems zu helfen.

Das untenstehende Diagramm ordnet den Freestyle-Job innerhalb des breiteren Bereichs an. kontinuierliche integration Schleife, vom Auschecken des Quellcodes bis hin zu den Aktionen nach dem Build, die das Ergebnis melden.

Schritte zum Erstellen eines Jobs in Jenkins Freestyle-Projekt
Wie man einen Job erstellt Jenkins

Voraussetzungen für die Erstellung eines Jenkins Freestyle-Job

Bevor die folgenden zehn Schritte vollständig funktionieren, müssen vier Voraussetzungen erfüllt sein. Fehlt eine davon, scheitert der erste Freestyle-Aufbau meist mit einem roten statt einem blauen Ball.

  • Ein laufender Jenkins Regler. Jenkins Lauscht standardmäßig auf Port 8080. Jenkins läuft noch nicht, folgen Sie dem Installationsanleitung zuerst.
  • Ein JDK auf dem Rechner, auf dem der Build ausgeführt wird. Das ausgearbeitete Beispiel kompiliert Java, damit javac Die Datei muss im Pfad des Controllers oder Agenten liegen, der den Auftrag ausführt. Bestätigen Sie dies mit einer einzeiligen Abfrage. java -version Führen Sie diesen Schritt aus, bevor Sie irgendetwas anderes hinzufügen.
  • Das Git-Plugin. Das Git Die Option wird nur unter Quelle angezeigt. Code Verwaltung nach der Installation des Plugins, durch Verwalten Jenkins > Plugins.
  • Ein erreichbares Repository. Ein öffentliches HTTPS URL benötigt keine Anmeldeinformationen. Ein privates Repository benötigt Anmeldeinformationen, die in einem Verzeichnis gespeichert sind. Jenkins zuerst, andernfalls schlägt der Checkout bereits beim ersten Build fehl.

Ein Konto bei der Job/Erstellen Außerdem wird eine Berechtigung benötigt – und zwar für eine neue Einzelbenutzer-Installation. Jenkins Das Administratorkonto verfügt bereits darüber.

So erstellen Sie einen neuen Build-Auftrag in Jenkins

Der Freestyle-Build-Job ist eine äußerst flexible und benutzerfreundliche Option. Sie können es für jede Art von Projekt verwenden; Es ist einfach einzurichten und viele seiner Optionen erscheinen in anderen Build-Jobs. Nachfolgend finden Sie einen schrittweisen Prozess zum Erstellen eines Jobs Jenkins.

Schritt 1) ​​Melden Sie sich an bei Jenkins

So erstellen Sie ein Jenkins Freestyle-Job, loggen Sie sich in Ihr Konto ein Jenkins Besuchen Sie Ihr Dashboard. Jenkins Installationspfad. Normalerweise wird es auf localhost gehostet unter http://localhost:8080 Wenn Sie installiert Jenkins Auf einem anderen Weg verwenden Sie die entsprechende URL Um auf Ihr Dashboard zuzugreifen, wie unten dargestellt Jenkins Beispiel für die Erstellung einer Arbeitsstelle.

Jenkins Dashboard erreicht bei Jenkins Installationspfad nach dem Anmelden

Schritt 2) Neues Element erstellen

Klicke auf "Neues Element„oben links in Ihrem Dashboard. Der Screenshot unten zeigt, wo sich dieser Link befindet.“

Link „Neuer Artikel“ oben links auf der Jenkins Dashboard

Schritt 3) Artikeldetails eingeben

Im nächsten Bildschirm

  1. Geben Sie den Namen des Elements ein, das Sie erstellen möchten. Für diese Demo verwenden wir „Hallo Welt“.
  2. Wählen Sie Freestyle-Projekt aus
  3. Klicken Sie auf „Okay“.

Feld mit dem Elementnamen, in dem das Freestyle-Projekt ausgewählt ist, bevor auf OK geklickt wird

Schritt 4) Projektdetails eingeben

Geben Sie die Details des Projekts ein, das Sie testen möchten. Die sich öffnende Konfigurationsseite wird unten angezeigt.

Projektdetails eingegeben auf dem Jenkins Freestyle-Jobkonfigurationsseite

Schritt 5) Repository aufrufen URL

Unter Quelle Code Verwaltung, Geben Sie Ihr Repository ein URLWir haben ein Test-Repository unter folgender Adresse: https://github.com/kriru/firstJava.git

Quelle Code Verwaltungsbereich mit dem Git-Test-Repository URL eingegeben

Es besteht auch die Möglichkeit, ein lokales Repository zu verwenden.

Wenn Ihr GitHub-Repository privat ist, Jenkins wird zuerst Ihre Anmeldeinformationen bei GitHub überprüfen und erst dann den Quellcode aus Ihrem GitHub-Repository abrufen.

Schritt 6) Passen Sie die Einstellungen an

Nachdem Sie nun alle Details angegeben haben, ist es an der Zeit, den Code zu erstellen. Passen Sie die Einstellungen unter folgendem Link an: bauen Abschnitt, um den Code zum gewünschten Zeitpunkt zu erstellen. Sie können den Build sogar so planen, dass er regelmäßig und zu festgelegten Zeiten ausgeführt wird.

Im Bau

  1. Klicke auf "Build-Schritt hinzufügen"
  2. Klicke auf "Ausführen Windows Batch-Befehl” und fügen Sie die Befehle hinzu, die Sie während des Build-Prozesses ausführen möchten.

Das Dropdown-Menü, in dem die verfügbaren Build-Schritte aufgelistet sind, sieht folgendermaßen aus.

Das Dropdown-Menü zum Hinzufügen eines Build-Schritts wurde auf der Seite zur Konfiguration des Freestyle-Jobs geöffnet.

⚠️ Versionshinweis: kürzlich Jenkins Veröffentlichungen kennzeichnen diesen Bereich Build-Schritte statt Bauenund unter Linux oder macOS Agenten, die entsprechende Option ist Shell ausführenDer Knopf heißt immer noch Build-Schritt hinzufügen.

Hier habe ich die Java-Befehle zum Kompilieren des Java-Codes hinzugefügt.

Ich habe die folgenden Windows-Befehle hinzugefügt:

javac HelloWorld.java
java HelloWorld

Das Befehlsfeld mit den beiden eingegebenen Zeilen wird unten angezeigt.

Ausführen Windows Befehlsfeld für Batchverarbeitung, das die Befehle javac und java enthält

Schritt 7) Speichern Sie das Projekt

Wenn Sie alle Daten eingegeben haben,

  1. Klicken Sie auf Tragen Sie
  2. Gespeichert Projekt.

Schritt 8) Quellcode erstellen

Klicken Sie nun im Hauptbildschirm auf der linken Seite auf die Schaltfläche „Jetzt erstellen“, um den Quellcode zu erstellen.

Die Schaltfläche „Jetzt erstellen“ auf der linken Seite des Freestyle-Projektbildschirms

Schritt 9) Überprüfen Sie den Status

Nachdem Sie auf „Jetzt erstellen“ geklickt haben, können Sie unter „Build-Verlauf“ den Status des von Ihnen ausgeführten Builds sehen.

Das Panel „Build-Verlauf“ zeigt den Status des ausgeführten Freestyle-Builds an.

Schritt 10) Sehen Sie sich die Konsolenausgabe an

Klicken Sie auf die Buildnummer und anschließend auf „Konsolenausgabe“, um den Status des ausgeführten Builds anzuzeigen. Vorausgesetzt, Sie haben die Einrichtung wie unten beschrieben korrekt durchgeführt, sollte eine Erfolgsmeldung angezeigt werden. Jenkins Beispiel für einen neuen Job erstellen.

Konsolenausgabe mit Erfolgsmeldung für den abgeschlossenen Build

Zusammenfassend lässt sich sagen, dass wir ein auf GitHub gehostetes HelloWorld-Programm ausgeführt haben. Jenkins Ruft den Code aus dem Remote-Repository ab und erstellt ihn kontinuierlich in einer von Ihnen festgelegten Frequenz.

Jenkins Erläuterung der Freestyle-Projektkonfigurationsabschnitte

Die obige Anleitung behandelt nur die Felder, die das HelloWorld-Beispiel benötigt. Die Konfigurationsseite selbst ist in sechs Formularabschnitte unterteilt, und wenn man weiß, wofür jeder Abschnitt zuständig ist, lassen sich die übrigen Optionen viel leichter finden.

Abschnitt Was es steuert Typische Einstellung
Allgemein Jobbeschreibung, Verwerfen alter Builds, Parameter und ob der Job auf einem bestimmten Agenten ausgeführt wird. Description plus eine Aufbau-Retentionsgrenze
Quellcodeverwaltung Welches Repository soll ausgecheckt werden und mit welchen Anmeldeinformationen und welchem ​​Branch? Git, ein HTTPS URL, sich verzeigen */master or */main
Trigger erstellen Was startet den Build automatisch? SCM abfragen, regelmäßig neu erstellen oder einen Webhook von GitHub verwenden
Umgebung erstellen Wrapper wurden um das gesamte Build-Element herum angewendet. Arbeitsbereich vor dem Build-Start löschen; Zeitstempel zum Konsolenprotokoll hinzufügen
Build-Schritte Die Befehle, die die eigentliche Arbeit erledigen, werden von oben nach unten ausgeführt. Ausführen Windows Batch-Befehl oder Shell ausführen
Aktionen nach dem Build Was geschieht, nachdem die Schritte abgeschlossen sind, unabhängig vom Ergebnis? ArchiDie Artefakte abrufen, einen Testbericht veröffentlichen, eine E-Mail senden

Zwei Gewohnheiten ersparen später viel Fehlersuche. Füge die Build-Schritte in der Reihenfolge hinzu, in der sie ausgeführt werden müssen, denn Jenkins Die Dateien werden von oben nach unten verarbeitet und beim ersten Fehler abgebrochen. Anschließend werden alle vom Build erzeugten Dateien als Nachbearbeitungsaktion archiviert, da der Arbeitsbereich vom nächsten Build wiederverwendet wird, während archivierte Artefakte pro Buildnummer gespeichert werden.

Freestyle-Projekt vs. Pipeline: Welches sollten Sie verwenden?

Freestyle ist nicht der einzige Projekttyp im Bildschirm „Neues Element“ und auch nicht immer der richtige. Die folgende Tabelle vergleicht ihn mit einem Pipeline-Job über die Punkte, die die meisten realen Entscheidungen bestimmen.

Vergleichspunkt Freestyle-Projekt Pipeline
Wie es definiert wird Webformulare, die im Job gespeichert sind config.xml auf dem Controller A JenkinsDatei wurde mit dem Anwendungscode übertragen
Geschichte verändern Gehalten von Jenkinsaußerhalb Ihres Repositorys Revwie jede andere Quelldatei eingesehen und versioniert.
Phasen und parallele Arbeit Eine einzige, flache Liste von Build-Schritten Benannte Phasen, parallele Verzweigungen und eine Phasenansicht
Lernkurve Keine Skripterstellung erforderlich Erfordert die deklarative Pipeline-Syntax
beste Passform Ein Kompilieren, ein Skript, eine geplante Aufgabe oder Lernen Jenkins Mehrstufige Build-, Test- und Bereitstellungsprozesse in verschiedenen Umgebungen

Eine praktische Regel: Greifen Sie auf Freestyle zurück, solange es sich um eine einzelne Aufgabe handelt und Sie das Werkzeug noch lernen, und verlagern Sie die Arbeit dann in einen größeren Bereich. CI / CD-Pipeline Sobald es eine zweite Phase erreicht oder zusammen mit dem Code überprüft werden muss. Teams, die paarweise Jenkins Mit Build-Tools erreicht man diesen Punkt oft schnell – ein Maven und Selenium -Setup ist ein häufiger Auslöser für den Schalter, und die gleiche Argumentation gilt für jeden Automatisierungstests Suite, die in mehreren Phasen abläuft.

Häufig gestellte Fragen

Die Konsolenausgabe nennt die Ursache. Die drei häufigsten Ursachen sind: javac fehlt im Agenten-Pfad, ein privates Repository ohne gespeicherte Anmeldeinformationen und ein falscher Branch-Name. Korrigieren Sie die gemeldete Zeile und führen Sie „Jetzt erstellen“ erneut aus.

Öffnen Sie Build-Trigger und aktivieren Sie das Kontrollkästchen. Regelmäßig erstellenGeben Sie dann die Cron-Syntax ein, zum Beispiel: H 2 * * * für einen nächtlichen Lauf. H verteilt die Last über die Stunde. Umfrage SCM Verwendet die gleiche Syntax, wird aber nur kompiliert, wenn sich das Repository ändert.

Wählen Shell ausführen aus dem Menü „Build-Schritt hinzufügen“ anstatt „Ausführen“. Windows Batch-Befehl. Die angezeigte Option hängt vom Betriebssystem des Controllers oder Agenten ab, an den der Auftrag gebunden ist, nicht von Ihrem eigenen Rechner.

Speichern Sie das Token oder den SSH-Schlüssel einmalig unter Verwalten Jenkins AnmeldeinformationenWählen Sie es anschließend im Dropdown-Menü „Anmeldeinformationen“ unter „Quelle“ aus. Code Managementbereich. Jenkins Die Anmeldeinformationen werden vor dem Bezahlvorgang validiert, sodass ein ungültiger Anmeldeinformationscode den Build sofort zum Fehlschlagen bringt.

Maschinelles Lernen analysiert Konsolenprotokolle und gruppiert wiederholte Fehler, um echte Kompilierungsfehler von fehlerhaften Agenten oder Timeouts zu unterscheiden. Diese Priorisierung führt Sie direkt zur relevanten Zeile, anstatt ein langes Protokoll manuell durchsuchen zu müssen.

GitHub-Copilot Erstellt Batch- oder Shell-Skripte innerhalb eines Build-Schritts und seine Befehlszeilenschnittstelle kann fehlgeschlagene Konsolenprotokolle zusammenfassen. Das Konfigurationsformular kann nicht durch Klicken durchlaufen werden; überprüfen Sie daher jeden generierten Befehl vor dem Speichern.

Speichern Archidie Artefakte als Nachbearbeitungsaktion und geben Sie ihr ein Muster wie beispielsweise **/*.class. ArchiDie ved-Dateien werden pro Build-Nummer gespeichert, sodass sie auch dann erhalten bleiben, wenn der Arbeitsbereich beim nächsten Durchlauf wiederverwendet oder bereinigt wird.

Jeder Job lebt in JENKINS_HOME/jobs/<job-name>, mit den Formulareinstellungen in config.xml und jeder Lauf unter builds/Es genügt, diesen Ordner zu sichern, um den Auftrag zu verschieben oder wiederherzustellen.

Fassen Sie diesen Beitrag mit folgenden Worten zusammen: