Hinweis: GitHub-gehostete Runner werden auf GitHub Enterprise Server derzeit nicht unterstützt. Weitere Informationen zur geplanten zukünftigen Unterstützung findest Du in der GitHub public roadmap.
Einführung
Dieser Leitfaden zeigt Dir, wie Du einen Workflow erstellen kannst, der eine kontinuierliche Integration (CI) für Dein Java-Projekt mit Hilfe des Build-Systems Ant durchführt. Der Workflow, den Du erstellst, zeigt Dir, wenn Commits zu einem Pull-Request zu Build- oder Testfehlern für deinen Standard-Zweig führen. Dieser Ansatz kann dazu beitragen, dass Dein Code immer brauchbar ist. Du kannst Deinen CI-Workflow so erweitern, dass er Artefakte von einem Workflow-Lauf hochlädt.
GitHub-gehostete Runner verfügen über einen Toolcache mit vorinstallierter Software, die Java Development Kits (JDKs) und Ant umfasst. Eine Liste der Software und der vorinstallierten Versionen für JDK und Ant findest du unter Using GitHub-hosted runners.
Voraussetzungen
Du solltest mit YAML und der Syntax für GitHub Actions vertraut sein. Weitere Informationen findest du unter:
Du solltest ein grundlegendes Verständnis von Java und dem Framework Ant haben. Weitere Informationen findest du im Handbuch zu Apache Ant.
Verwendung von selbstgehosteten Runnern auf GitHub Enterprise Server
Wenn du Setup-Aktionen (wie z.B.actions/setup-LANGUAGE
) auf GitHub Enterprise Server mit selbstgehosteten Runnern verwendest, musst du möglicherweise den Tools-Cache auf Runnern einrichten, die keinen Internetzugang haben. Weitere Informationen finden Sie unter Einrichten des Toolcaches auf selbstgehosteten Runnern ohne Internetzugriff.
Verwenden des Ant-Starterworkflows
GitHub bietet einen Ant-Starterworkflow, der für die meisten Ant-basierten Java-Projekte funktionieren wird. Weitere Informationen findest du im Ant-Starterworkflow. Die Standardstartworkflows sind ausgezeichnete Ausgangspunkte beim Erstellen von Build- und Testworkflows, und du kannst den Startworkflow den Anforderungen deines Projekts anpassen.
Um schnell loszulegen, kannst du beim Erstellen eines neuen Workflows den vorkonfigurierten Ant-Starterworkflow auswählen. Weitere Informationen findest du unter Schnellstart für GitHub Actions.
Du kannst diesen Workflow auch manuell hinzufügen, indem du eine neue Datei im Verzeichnis .github/workflows
deines Repositorys erstellst.
# Der Name des Workflows. GitHub zeigt die Namen deiner Workflows auf der Registerkarte „Aktionen“ deines Repositorys an. Wenn du `name` weglässt, zeigt GitHub den Workflowdateipfad relativ zum Stammverzeichnis des Repositorys an. name: Java CI # on: [push] # jobs: build: # <!-- This is a YAML comment for use in annotated code examples. --> # Du kannst diesen Workflow mit einem anderen Betriebssystem ausführen. # # Die Vorlage zum Starter-Workflow konfiguriert Aufträge zur Ausführung unter Linux und verwendet mit GitHub gehostete `ubuntu-latest`-Runner. Du kannst den `runs-on`-Schlüssel ändern, um deine Aufträge auf einem anderen Betriebssystem auszuführen. # # Beispielsweise kannst du die GitHub-gehosteten Windows-Runner verwenden`runs-on: windows-latest`. Oder du kannst die GitHub-gehosteten macOS-Runner verwenden`runs-on: macos-latest`. # # Du kannst Aufträge auch in Docker-Containern ausführen oder einen selbst gehosteten Läufer bereitstellen, der auf Deiner eigenen Infrastruktur läuft. Weitere Informationen findest du unter [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on). runs-on: ubuntu-latest # steps: # In diesem Schritt wird die Aktion `actions/checkout` verwendet, um eine Kopie deines Repositorys auf den Runner herunterzuladen. - uses: actions/checkout@v4 # In diesem Schritt wird die Aktion `actions/setup-java` verwendet, um das Eclipse Temurin 17-JDK (Java) von Eclipse Adoptium zu konfigurieren. - name: Set up JDK 17 uses: actions/setup-java@v3 with: java-version: '17' distribution: 'temurin' # This step runs the default target in your `build.xml` file in non-interactive mode. - name: Build with Ant run: ant -noinput -buildfile build.xml
name: Java CI
Der Name des Workflows. GitHub zeigt die Namen deiner Workflows auf der Registerkarte „Aktionen“ deines Repositorys an. Wenn du name
weglässt, zeigt GitHub den Workflowdateipfad relativ zum Stammverzeichnis des Repositorys an.
on: [push]
jobs:
build:
runs-on: ubuntu-latest
Du kannst diesen Workflow mit einem anderen Betriebssystem ausführen.
Die Vorlage zum Starter-Workflow konfiguriert Aufträge zur Ausführung unter Linux und verwendet mit GitHub gehostete ubuntu-latest
-Runner. Du kannst den runs-on
-Schlüssel ändern, um deine Aufträge auf einem anderen Betriebssystem auszuführen.
Beispielsweise kannst du die GitHub-gehosteten Windows-Runner verwendenruns-on: windows-latest
. Oder du kannst die GitHub-gehosteten macOS-Runner verwendenruns-on: macos-latest
.
Du kannst Aufträge auch in Docker-Containern ausführen oder einen selbst gehosteten Läufer bereitstellen, der auf Deiner eigenen Infrastruktur läuft. Weitere Informationen findest du unter Workflowsyntax für GitHub Actions.
steps:
- uses: actions/checkout@v4
In diesem Schritt wird die Aktion actions/checkout
verwendet, um eine Kopie deines Repositorys auf den Runner herunterzuladen.
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
In diesem Schritt wird die Aktion actions/setup-java
verwendet, um das Eclipse Temurin 17-JDK (Java) von Eclipse Adoptium zu konfigurieren.
- name: Build with Ant
run: ant -noinput -buildfile build.xml
This step runs the default target in your build.xml
file in non-interactive mode.
# Der Name des Workflows. GitHub zeigt die Namen deiner Workflows auf der Registerkarte „Aktionen“ deines Repositorys an. Wenn du `name` weglässt, zeigt GitHub den Workflowdateipfad relativ zum Stammverzeichnis des Repositorys an.
name: Java CI
#
on: [push]
#
jobs:
build:
# <!-- This is a YAML comment for use in annotated code examples. -->
# Du kannst diesen Workflow mit einem anderen Betriebssystem ausführen.
#
# Die Vorlage zum Starter-Workflow konfiguriert Aufträge zur Ausführung unter Linux und verwendet mit GitHub gehostete `ubuntu-latest`-Runner. Du kannst den `runs-on`-Schlüssel ändern, um deine Aufträge auf einem anderen Betriebssystem auszuführen.
#
# Beispielsweise kannst du die GitHub-gehosteten Windows-Runner verwenden`runs-on: windows-latest`. Oder du kannst die GitHub-gehosteten macOS-Runner verwenden`runs-on: macos-latest`.
#
# Du kannst Aufträge auch in Docker-Containern ausführen oder einen selbst gehosteten Läufer bereitstellen, der auf Deiner eigenen Infrastruktur läuft. Weitere Informationen findest du unter [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on).
runs-on: ubuntu-latest
#
steps:
# In diesem Schritt wird die Aktion `actions/checkout` verwendet, um eine Kopie deines Repositorys auf den Runner herunterzuladen.
- uses: actions/checkout@v4
# In diesem Schritt wird die Aktion `actions/setup-java` verwendet, um das Eclipse Temurin 17-JDK (Java) von Eclipse Adoptium zu konfigurieren.
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
# This step runs the default target in your `build.xml` file in non-interactive mode.
- name: Build with Ant
run: ant -noinput -buildfile build.xml
Spezifizieren der JVM-Version und -Architektur
Der Starterworkflow richtet PATH
so ein, dass OpenJDK 8 für die x64-Plattform enthalten ist. Wenn du eine andere Java-Version verwenden willst oder auf eine andere Architektur (x64
oder x86
) abzielen möchtest, kannst du die setup-java
-Aktion verwenden, um eine andere Java-Laufzeitumgebung auszuwählen.
Um etwa Version 11 des JDK zu verwenden, das von Adoptium für die x64-Plattform bereitgestellt wird, kannst du die Aktion setup-java
verwenden und die Parameter java-version
, distribution
und architecture
für '11'
, 'temurin'
und x64
konfigurieren.
steps: - uses: actions/checkout@v4 - name: Set up JDK 11 for x64 uses: actions/setup-java@v3 with: java-version: '11' distribution: 'temurin' architecture: x64
steps:
- uses: actions/checkout@v4
- name: Set up JDK 11 for x64
uses: actions/setup-java@v3
with:
java-version: '11'
distribution: 'temurin'
architecture: x64
Weitere Informationen findest du unter der Aktion setup-java
.
Deinen Code bauen und testen
Du kannst die gleichen Befehle verwenden, die Du auch lokal verwendest, um Deinen Code zu bauen und zu testen.
Der Starterworkflow führt das in der Datei build.xml angegebene Standardziel aus. Dein Standard-Ziel wird normalerweise eingestellt, um Klassen zu bauen, Tests durchzuführen und Klassen in ihr verteilbares Format (z.B . eine JAR-Datei) zu paketieren.
Wenn Du zum Bauen Deines Projekts andere Befehle verwenden oder ein anderes Ziel auszuführen möchtest, kannst Du dies angeben. Du kannst beispielsweise das jar
-Ziel ausführen, das in deiner Datei _build-ci.xml_
konfiguriert ist.
steps: - uses: actions/checkout@v4 - uses: actions/setup-java@v3 with: java-version: '17' distribution: 'temurin' - name: Run the Ant jar target run: ant -noinput -buildfile build-ci.xml jar
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
- name: Run the Ant jar target
run: ant -noinput -buildfile build-ci.xml jar
Workflow-Daten als Artefakte paketieren
Nachdem sowohl Build erfolgreich war und deine Tests bestanden hat, wirst du die resultierenden Java-Pakete als Build-Artefakt hochladen wollen. Dies speichert die gebauten Pakete als Teil der Workflow-Ausführung und ermöglicht Dir, sie herunterzuladen. Artefakte können Dir helfen, Pull-Requests in deiner lokalen Umgebung zu testen und zu debuggen, bevor sie zusammengeführt werden („merge“). Weitere Informationen findest du unter Speichern von Workflowdaten als Artefakte.
Ant erstellt normalerweise Ausgabedateien wie JAR-, EAR- oder WAR-Dateien im Verzeichnis build/jar
. Du kannst den Inhalt dieses Verzeichnisses mit der Aktion upload-artifact
hochladen.
steps: - uses: actions/checkout@v4 - uses: actions/setup-java@v3 with: java-version: '17' distribution: 'temurin' - run: ant -noinput -buildfile build.xml - uses: actions/upload-artifact@v3 with: name: Package path: build/jar
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
- run: ant -noinput -buildfile build.xml
- uses: actions/upload-artifact@v3
with:
name: Package
path: build/jar