From eb648f69c28055dca4ae119a49ab928174804b85 Mon Sep 17 00:00:00 2001 From: Wolfram Gulde Date: Tue, 5 Jul 2022 15:59:22 +0200 Subject: [PATCH] docs(exx-Pipeline): add licensing tool docs for maven and gradle --- .../java/gradle/gradle-build-template.adoc | 1 + .../java/gradle/gradle-license.gitlab-ci.adoc | 15 +++++++++++++++ .../java/maven/maven-build-template.adoc | 1 + .../java/maven/maven-license.gitlab-ci.adoc | 16 ++++++++++++++++ 4 files changed, 33 insertions(+) create mode 100644 documentation/chapters/templates/java/gradle/gradle-license.gitlab-ci.adoc create mode 100644 documentation/chapters/templates/java/maven/maven-license.gitlab-ci.adoc diff --git a/documentation/chapters/templates/java/gradle/gradle-build-template.adoc b/documentation/chapters/templates/java/gradle/gradle-build-template.adoc index 7ea347c..39f4e78 100644 --- a/documentation/chapters/templates/java/gradle/gradle-build-template.adoc +++ b/documentation/chapters/templates/java/gradle/gradle-build-template.adoc @@ -1,3 +1,4 @@ +[#_Gradle-build-template] = Gradle-build-template This template resolves the gradle dependencies of your project and builds the project. diff --git a/documentation/chapters/templates/java/gradle/gradle-license.gitlab-ci.adoc b/documentation/chapters/templates/java/gradle/gradle-license.gitlab-ci.adoc new file mode 100644 index 0000000..6ffc1b4 --- /dev/null +++ b/documentation/chapters/templates/java/gradle/gradle-license.gitlab-ci.adoc @@ -0,0 +1,15 @@ += Gradle license template + +This template executes the cycloneBom gradle task which generates license information from gradle.xml files and stores them in a _bom.xml_ file. For more details: https://gitlab.exxcellent.de/gilden/ci/exxcellent-license-tools[Gilde CI/CD: exxcellent-license-tool]. + +TIP: Instead of using this template to generate the bom file you can simply include the _cyclonedxBom_ task in your regular gradle build <<_Gradle-build-template>> by adding it to the _GRADLE_CLI_OPTS_. + +.Variables +|=== +|Name |Description | Default Value +|GRADLE_CLI_OPTS | Additional Options that will be passed to Gradle | "" +|GRADLE_EXTRA_OPTS | Additional Extra Options that will be passed to Gradle | "" +|=== + +:template: java/gradle/gradle-license.gitlab-ci.yml +include::../../../../template-printer.adoc[] \ No newline at end of file diff --git a/documentation/chapters/templates/java/maven/maven-build-template.adoc b/documentation/chapters/templates/java/maven/maven-build-template.adoc index 156e024..94365fd 100644 --- a/documentation/chapters/templates/java/maven/maven-build-template.adoc +++ b/documentation/chapters/templates/java/maven/maven-build-template.adoc @@ -1,3 +1,4 @@ +[#_Maven-build-template] = maven-build-template These Templates will build a .jar file with Maven and provides it as an Artifact diff --git a/documentation/chapters/templates/java/maven/maven-license.gitlab-ci.adoc b/documentation/chapters/templates/java/maven/maven-license.gitlab-ci.adoc new file mode 100644 index 0000000..23f4528 --- /dev/null +++ b/documentation/chapters/templates/java/maven/maven-license.gitlab-ci.adoc @@ -0,0 +1,16 @@ += Maven license template + +This template executes the cycloneBom maven task which generates license information from pom.xml files and stores them in a _bom.xml_ file. For more details: https://gitlab.exxcellent.de/gilden/ci/exxcellent-license-tools[Gilde CI/CD: exxcellent-license-tool]. + +TIP: Instead of using this template to generate the bom file you can simply include the _cyclonedxBom_ task in your regular maven build <<_Maven-build-template>> by adding it to the _MAVEN_EXTRA_OPTS_. + +.Variables +|=== +|Name |Description | Default Value +|MAVEN_CLI_OPTS | Additional Options that will be passed to Maven | "" +|MAVEN_EXTRA_OPTS | Additional extra options that will be passed to Maven | "" +|MAVEN_EXTRA_ARGS | Additional extra args that will be passed to Maven | "" +|=== + +:template: java/maven/maven-license.gitlab-ci.yml +include::../../../../template-printer.adoc[] \ No newline at end of file