Introduction
Ce guide explique comment créer un workflow qui effectue une intégration continue (CI) pour votre projet Java à l’aide de l’outil de gestion de projet logiciel Maven. Le workflow que vous créez vous permet de voir à quel moment les commits de demande de tirage (pull request) entraînent des échecs de build ou de test dans votre branche par défaut. Cette approche peut vous aider à garantir l’intégrité de votre code. Vous pouvez étendre votre workflow CI pour mettre en cache des fichiers et charger des artefacts à partir d’une exécution de workflow.
Les exécuteurs hébergés dans GitHub ont un cache d’outils où des logiciels sont préinstallés, notamment les Java Development Kits (JDKs) et Maven. Pour obtenir la liste des logiciels et des versions préinstallées de JDK et de Maven, consultez « À propos des exécuteurs hébergés par GitHub ».
Prérequis
Vous devez être familiarisé avec YAML et la syntaxe GitHub Actions. Pour plus d'informations, consultez les pages suivantes :
Il est recommandé d’avoir une compréhension de base de Java et du framework Maven. Pour plus d’informations, consultez Maven Getting Started Guide dans la documentation Maven.
Utilisation du workflow de démarrage Maven
GitHub fournit un workflow de démarrage Maven qui fonctionnera pour la plupart des projets Java basés sur Maven. Pour plus d’informations, consultez Workflow de démarrage Maven.
Pour commencer rapidement, vous pouvez choisir le workflow de démarrage Maven préconfiguré lorsque vous créez un workflow. Pour plus d’informations, consultez « Démarrage rapide pour GitHub Actions ».
Vous pouvez également ajouter ce workflow manuellement en créant un fichier dans le répertoire .github/workflows
de votre dépôt.
name: Java CI
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
- name: Build with Maven
run: mvn --batch-mode --update-snapshots package
Ce workflow effectue les étapes suivantes :
- L’étape
checkout
télécharge une copie de votre dépôt sur l’exécuteur. - L’étape
setup-java
configure le JDK Eclipse Temurin (Java) 17 d’Eclipse Adoptium. - L’étape « Build with Maven » exécute la cible
package
Maven en mode non interactif pour permettre la génération de votre code, la réussite de vos tests et la création d’un package.
Les workflows de démarrage par défaut sont d’excellents points de départ lorsque vous créez votre workflow de build et de test. En outre, vous pouvez personnaliser le workflow de démarrage en fonction des besoins de votre projet.
Exécution sur un autre système d’exploitation
Le workflow de démarrage configure les travaux à exécuter sur Linux, à l’aide d’exécuteurs ubuntu-latest
hébergés par GitHub. Vous pouvez modifier la clé runs-on
pour exécuter vos travaux sur un autre système d’exploitation. Par exemple, vous pouvez utiliser des exécuteurs Windows hébergés par GitHub.
runs-on: windows-latest
Vous pouvez également exécuter sur les exécuteurs de données macOS hébergés par GitHub.
runs-on: macos-latest
Vous pouvez également exécuter des travaux dans des conteneurs Docker, ou vous pouvez fournir un exécuteur auto-hébergé qui s’exécute sur votre propre infrastructure. Pour plus d’informations, consultez « Workflow syntax for GitHub Actions ».
Spécification de la version et de l’architecture de JVM
Le workflow de démarrage configure le PATH
pour contenir OpenJDK 8 pour la plateforme x64. Si vous souhaitez utiliser une autre version de Java ou cibler une architecture différente (x64
ou x86
), vous pouvez utiliser l’action setup-java
pour choisir un autre environnement d’exécution Java.
Par exemple, pour utiliser la version 11 du JDK fourni par Adoptium pour la plateforme x64, vous pouvez utiliser l’action setup-java
et configurer les paramètres java-version
, distribution
et architecture
sur '11'
, 'adopt'
et x64
.
steps:
- uses: actions/checkout@v3
- name: Set up JDK 11 for x64
uses: actions/setup-java@v3
with:
java-version: '11'
distribution: 'adopt'
architecture: x64
Pour plus d’informations, consultez l’action setup-java
.
Génération et test de votre code
Vous pouvez utiliser les mêmes commandes que celles que vous utilisez localement pour générer et tester votre code.
Le workflow de démarrage exécute la cible package
par défaut. Dans la configuration Maven par défaut, cette commande télécharge les dépendances, génère les classes, exécute les tests et empaquettent les classes dans un format distribuable, par exemple, dans un fichier JAR.
Si vous utilisez différentes commandes pour générer votre projet ou si vous souhaitez utiliser une autre cible, vous pouvez les spécifier. Par exemple, vous pouvez exécuter la cible verify
qui est configurée dans un fichier pom-ci.xml.
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
- name: Run the Maven verify phase
run: mvn --batch-mode --update-snapshots verify
Mise en cache des dépendances
Vous pouvez mettre en cache vos dépendances pour accélérer vos exécutions de workflow. Une fois l’exécution réussie, votre dépôt Maven local est stocké dans un cache. Dans les prochaines exécutions de workflows, le cache sera restauré afin que les dépendances n’aient pas besoin d’être téléchargées à partir des dépôts Maven distants. Vous pouvez mettre en cache les dépendances à l’aide de l’action setup-java
ou utiliser l’action cache
pour une configuration personnalisée et plus avancée.
steps:
- uses: actions/checkout@v3
- name: Set up JDK 11
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
cache: maven
- name: Build with Maven
run: mvn --batch-mode --update-snapshots verify
Ce workflow enregistre le contenu de votre dépôt Maven local, qui est situé dans le répertoire .m2
du répertoire de base de l’exécuteur. La clé de cache sera le contenu haché de pom.xml. Par conséquent, toute modification apportée à pom.xml rendra le cache non valide.
Empaquetage des données de workflow en tant qu’artefacts
Une fois que votre build a été générée et que vos tests ont réussi, vous pouvez charger les packages Java résultants en tant qu’artefacts de build. Cela stockera les packages générés dans le cadre de l’exécution du workflow et vous permettra de les télécharger. Les artefacts peuvent vous aider à tester et à déboguer des demandes de tirage dans votre environnement local avant qu’elles ne soient fusionnées. Pour plus d’informations, consultez « Stockage des données de workflow en tant qu’artefacts ».
Maven crée généralement des fichiers de sortie comme les fichiers JAR, EAR ou WAR dans le répertoire target
. Pour charger ces fichiers en tant qu’artefacts, vous pouvez les copier dans un nouveau répertoire qui contient les artefacts à charger. Par exemple, vous pouvez créer un répertoire appelé staging
. Vous pouvez ensuite charger le contenu de ce répertoire à l’aide de l’action upload-artifact
.
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
- run: mvn --batch-mode --update-snapshots verify
- run: mkdir staging && cp target/*.jar staging
- uses: actions/upload-artifact@v3
with:
name: Package
path: staging