Skip to content

Commit

Permalink
Updated README and GH Actions
Browse files Browse the repository at this point in the history
I modified the GitHub Actions
to verify the build and the javadoc before we can push on main.
  • Loading branch information
LBF38 committed Jan 4, 2023
1 parent 5a52cdb commit 1de8954
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# separate terms of service, privacy policy, and support
# documentation.

name: Java CI with Maven
name: Verify Maven build and javadoc for Java project

on:
push:
Expand All @@ -29,4 +29,4 @@ jobs:
distribution: 'temurin'
cache: maven
- name: Build with Maven
run: mvn -B package --file duelinvaders/pom.xml
run: mvn clean javadoc:jar -B package --file duelinvaders/pom.xml
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,17 @@ mvn clean package
> **Note**
> Vous devez exécuter cette commande dans le dossier du projet contenant le fichier `pom.xml`. Ici, le dossier racine du projet est `duelinvaders`.
Vous pouvez également compiler la javadoc du projet en exécutant la commande suivante :

```bash
mvn javadoc:javadoc
```

La javadoc sera générée dans le dossier `target/site/apidocs` du projet. (par défaut)

> **Note**
> Les releases fournissent la javadoc du projet en archive `.jar`. Ils sont builds avec la commande `mvn clean package javadoc:jar` et sont disponibles dans la section [Releases](https://github.com/LBF38/Duel-invaders/releases) du projet.
### Exécution

> **Warning**
Expand Down

0 comments on commit 1de8954

Please sign in to comment.