From e26f69443c8217e652457babe49ad4ba210d45a9 Mon Sep 17 00:00:00 2001 From: Roberto Cirillo Date: Fri, 21 Jul 2023 12:58:38 +0200 Subject: [PATCH] improve README --- README.md | 41 ++++++++++++++++++++++++++++++++--------- 1 file changed, 32 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6a2fced..9a06668 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A parent pom for all the gCube artifacts. # Enforcements -* Java 8 (target and source) +* Java 8 (target and source) unless otherwise specified inside the pom * OpenJDK as target Java VM. * Maven 3.3.9+ * 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 -## 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 * Snapshot artifacts installed to local * Snapshot artifacts deployed to gcube-snapshots * Deployments of releases artifacts are not permitted -## jenkins-snapshots -* 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 +## jenkins-staging-official * Dependencies resolved against local-staging, gcube-jenkins-staging, gcube-staging and gcube-releases * Release/snapshot artifacts installed to local-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. 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 +