paul/gilde-ci-cd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs(exx-Pipeline): add licensing tool docs

Browse Source
This commit is contained in:
Wolfram Gulde 2022-07-05 09:20:09 +02:00 committed by Marcel Feix
parent 357641729a
commit c96998380c
No known key found for this signature in database
GPG Key ID: 04D016E104A25F03
2 changed files with 41 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
documentation/chapters/templates/license/license.gitlab-ci.adoc Normal file
View File

@ -0,0 +1,35 @@
= license-template
This template provides a service to collect, validate and publish generated license information for a project. For more details: https://gitlab.exxcellent.de/gilden/ci/exxcellent-license-tools[Gilde CI/CD: exxcellent-license-tool].
TIP: The license tool needs a _bom.json_ file which is generated in a previous stage. This is generally done as a part of the build stage (p.ex. by adding cyclonedxBom to the gradle build) and then providing the generated bom.json with artifacts. Again, see https://gitlab.exxcellent.de/gilden/ci/exxcellent-license-tools[Gilde CI/CD: exxcellent-license-tool] for more infos
The following use cases are possible:
__Generate Asciidoc for all licenses:__
- Set BOM_FILE (source)
- Set LICENSE_ADOC_FILE (target)
__Validate licenses and generate Asciidoc file:__
- Set BOM_FILE (source)
- Set LICENSE_ADOC_FILE (target)
- Set INVALID_LICENSE_ADOC_FILE (target)
- Set ALLOWED_LICENSES
.Variables
|===
|Name |Description | Default Value
|BOM_FILE | the path to the bom file (provided in artifacts from previous stage)|bom.json
|ALLOWED_LICENSES | path to the text file with line separated list of allowed licenses |valid-licenses.txt
|LICENSE_ADOC_FILE | path to the generated adoc file with all licenses |licenses.adoc
|INVALID_LICENSE_ADOC_FILE | path to the generated adoc file with invalid licenses |invalid-licenses.adoc
|NUMBER_OF_ALLOWED_FAILURES | number of allowed invalid licenses |0
|===
:template: license/license.gitlab-ci.yml
include::../../../template-printer.adoc[]

8
documentation/document.adoc
View File

@ -134,9 +134,13 @@ This collection provides templates to simplify your dokumentation prozess.
include::chapters/templates/documentation/documentation.adoc[leveloffset=2]
== Licensing
This collection provides templates to simplify your licencing prozess.
include::chapters/templates/license/license.gitlab-ci.adoc[leveloffset=2]
[#_pipelines]
=== Pipelines
include::chapters/pipelines/eXXcellent-release.adoc[leveloffset=3]
//todo licensing documentieren