Skip to content

Commit

Permalink
doc: add some initial docs about this POM
Browse files Browse the repository at this point in the history
  • Loading branch information
poikilotherm committed Jul 10, 2024
1 parent 54b7c45 commit 8d6b0ea
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,28 @@
# maven-parent
A common Maven Parent for all GDCC and IQSS Java projects

A common Maven Parent for all GDCC and IQSS Java projects:

```xml
<parent>
<groupId>io.gdcc</groupId>
<artifactId>parent</artifactId>
<version>x.y.z</version>
</parent>
```

## Important variables

| Maven Property | Description |
|----------------|-----------------------------------------------------|
| `jdk.version` | The minimum Java version a project can be used with |
| `skipUT` | Skip executing unit tests with Surefire |
| `skipIT` | Skip executing integration tests with Failsafe |

(There are more, docs to be done)

## Profiles

| Maven Profile | Description |
|---------------|--------------------------------------------------|
| `release` | Prepare a package for releasing to Maven Central |
| `coverage` | Run JaCoCo, also contains some Sonar properties |

0 comments on commit 8d6b0ea

Please sign in to comment.