docs: add notes about dynamic project info #15

gdcc · Oct 18, 2024 · 2a134c0 · 2a134c0
1 parent 2030927
commit 2a134c0
Showing 1 changed file with 10 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -10,13 +10,18 @@ A common Maven Parent for all GDCC and IQSS Java projects:
 </parent>
 ```
 
+Aside from dependencies and plugin management, the Parent POM provides sane defaults for `<groupId>` and the extended project information bits `<url>`, `<organization>`, `<issueManagement>`, `<scm>`, `<ciManagement>` and `<distributionManagement>`.
+You can always completely override them in a child project.
+
 ## 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      |
+| 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            |
+| `project.github.org`  | Default `gdcc`, influencing project info                  |
+| `project.github.repo` | Default `${project.artifactId}`, influencing project info |
 
 (There are more, docs to be done)