docs(exx-Pipeline): add licensing tool docs for maven and gradle

This commit is contained in:
Wolfram Gulde 2022-07-05 15:59:22 +02:00 committed by Marcel Feix
parent 42589e0871
commit eb648f69c2
No known key found for this signature in database
GPG Key ID: 04D016E104A25F03
4 changed files with 33 additions and 0 deletions

View File

@ -1,3 +1,4 @@
[#_Gradle-build-template]
= Gradle-build-template
This template resolves the gradle dependencies of your project and builds the project.

View File

@ -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[]

View File

@ -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

View File

@ -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[]