gCubeSystem
/
maven-parent
15
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

improve README

This commit is contained in:
Roberto Cirillo 2023-07-21 12:58:38 +02:00
parent 836a4f69ee
commit e26f69443c
1 changed files with 32 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -3,7 +3,7 @@
A parent pom for all the gCube artifacts. A parent pom for all the gCube artifacts.
# Enforcements # Enforcements
* Java 8 (target and source) * Java 8 (target and source) unless otherwise specified inside the pom
* OpenJDK as target Java VM. * OpenJDK as target Java VM.
* Maven 3.3.9+ * Maven 3.3.9+
* README.md, CHANGELOG.md and LICENSE.md are present in the baseDir of each Maven module * README.md, CHANGELOG.md and LICENSE.md are present in the baseDir of each Maven module
@ -11,19 +11,39 @@ A parent pom for all the gCube artifacts.
# Build Profiles # Build Profiles
## gcube-developer The build profiles are separated in three main branches: developer, staging, releases.
Each branch has a set of profile based on the idk.
The developer branch contains the profiles related to the snapshot build:
* gcore-legacy jdk7
* gcube-legacy - jdk8
* gcube-official -jdk11
* gcube-experimental - jdk17
In the same way are organised the other branch profiles related to the staging (integration) phase and to the release phase.
In addition there are a set of common profiles useful in order to avoid replication of plugins and rules definitions:
* common-snapshot
* common-release
* dry-run
* disable-java8-doclint
* set-local-classpath
* generate-distribution-packages
Below the descriptions of the most used profiles by gCube components:
## common-snapshot
This profile defines the common plugin used by all the snapshot profiles
## common-releases
This profile defines the common plugin used by all the staging and release profiles
## gcube-official
* Dependencies resolved against local, gcube-snapshots and gcube-releases * Dependencies resolved against local, gcube-snapshots and gcube-releases
* Snapshot artifacts installed to local * Snapshot artifacts installed to local
* Snapshot artifacts deployed to gcube-snapshots * Snapshot artifacts deployed to gcube-snapshots
* Deployments of releases artifacts are not permitted * Deployments of releases artifacts are not permitted
## jenkins-snapshots ## jenkins-staging-official
* Dependencies resolved against local-snapshots, gcube-snapshots and gcube-releases
* Snapshot artifacts installed to local-snapshots
* Snapshot artifacts deployed to gcube-snapshots
* Deployments of release artifacts are not permitted
## jenkins-staging
* Dependencies resolved against local-staging, gcube-jenkins-staging, gcube-staging and gcube-releases * Dependencies resolved against local-staging, gcube-jenkins-staging, gcube-staging and gcube-releases
* Release/snapshot artifacts installed to local-staging * Release/snapshot artifacts installed to local-staging
* Release/snapshot artifacts deployed to gcube-jenkins-staging * Release/snapshot artifacts deployed to gcube-jenkins-staging
@ -41,3 +61,6 @@ This profile disables the deployment of the artifacts.
This profile sets an additional parameter for javadoc generation to disables the doclint. This profile sets an additional parameter for javadoc generation to disables the doclint.
It avoids the build fails if formal/syntax errors are found in javadoc comments. It avoids the build fails if formal/syntax errors are found in javadoc comments.
## set-local-classpath
This profile set a generic folder that will be added to the classpath