Skip to content

Commit

Permalink
Improved structure of documentation on the different Readers for proc…
Browse files Browse the repository at this point in the history
…essing data of Gradle projects (#294)
  • Loading branch information
ohecker authored Dec 10, 2024
1 parent a589996 commit 6af82dc
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions documentation/master-solicitor.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -848,11 +848,14 @@ WARNING: The ORT reader currently does not yet fill the attribute `licenseUrl`.

=== Gradle

Gradle projects should use the https://github.com/jk1/Gradle-License-Report[Gradle License Report] to generate the Solicitor input files. Support for the https://github.com/jaredsburrows/gradle-license-plugin[Gradle License Plugin] is deprecated as it might lead to incomplete results.
For Gradle two alternative plugins exist to create input data for Solicitor:

==== Gradle License Report Plugin
* Gradle License Report
* Gradle License Plugin (usage of this plugin with Solicitor is discouraged and deprecated)

Pick the correct version of the https://github.com/jk1/Gradle-License-Report[Gradle License Report Plugin] depending on you Gradle version. Add the plugin to the list of plugins in your `build.gradle` file:
==== Gradle License Report

Pick the correct version of the https://github.com/jk1/Gradle-License-Report[Gradle License Report plugin] depending on your Gradle version. Add the plugin to the list of plugins in your `build.gradle` file:

Gradle v7+:
----
Expand Down Expand Up @@ -898,12 +901,12 @@ In Solicitor the Data is read with the following part of the config
} ]
----

==== gradle-license-plugin, Windows
==== Gradle License Plugin (Windows)

WARNING: The gradle-license-plugin does not include dependencies into the report if they have no license info declared. This might result in incomplete data in the Solicitor output. The usage
of this plugin is discouraged and the 'gradle2' reader is deprecated (stage 2). Use the <<Gradle License Report Plugin>> instead.
WARNING: The Gradle License Plugin does not include dependencies into the result if they have no license info declared. This might result in incomplete data in the Solicitor output. The usage
of this plugin is therefore discouraged and the 'gradle2' reader is deprecated (stage 2). Use the <<Gradle License Report>> instead.

For the export of the licenses from a Gradle based project the Gradle License Plugin is used.
For the export of the licenses from a Gradle based project the Gradle License Plugin might be used.

To install the plugin some changes need to be done in `build.gradle`, like following example
----
Expand Down Expand Up @@ -947,12 +950,12 @@ In _Solicitor_ the data is read with the following part of the config
} ]
----

==== gradle-license-plugin, Android
==== Gradle License Plugin (Android)

WARNING: The gradle-license-plugin does not include dependencies into the report if they have no license info declared. This might result in incomplete data in the Solicitor output. The usage
of this plugin is discouraged and the 'gradle2' reader is deprecated (stage 2). Use the <<Gradle License Report Plugin>> instead.
WARNING: The Gradle License Plugin does not include dependencies into the result if they have no license info declared. This might result in incomplete data in the Solicitor output. The usage
of this plugin is therefore discouraged and the 'gradle2' reader is deprecated (stage 2). Use the <<Gradle License Report>> instead.

For the Export of the the Licenses from a Gradle based Android Projects the Gradle License Plugin is used.
For the export of the the Licenses from a Gradle based Android Projects the Gradle License Plugin might be used.

To install the Plugin some changes need to be done in the build.gradle of the Project, like following example
----
Expand Down Expand Up @@ -2153,6 +2156,7 @@ Spring beans implementing this interface will be called at certain points in the
== Release Notes
Changes in 1.30.0::
* https://github.com/devonfw/solicitor/pull/292: Improved the extraction of spdxids from spdx expressions when parsing ScanCode V32 result files. Previously the result might have contained empty strings to be returned as spdxids.
* https://github.com/devonfw/solicitor/issues/293: Improved structure of documentation on the different Readers for processing data of <<Gradle>> projects.

Changes in 1.29.0::
* https://github.com/devonfw/solicitor/pull/291: Fixed a bug in the processing of ScanCode V32 files.
Expand All @@ -2163,7 +2167,7 @@ Changes in 1.28.0::
* https://github.com/devonfw/solicitor/issues/12: New `statistics` Velocity and SQL template which can be used in a build-breaker.

Changes in 1.27.0::
* https://github.com/devonfw/solicitor/issues/283: New Reader for data generated by the Gradle License Report Plugin. See <<Gradle License Report Plugin>>. Reader `gradle2` deprecated (stage 2). Reader `gradle` removed.
* https://github.com/devonfw/solicitor/issues/283: New Reader for data generated by the Gradle License Report Plugin. See <<Gradle License Report>>. Reader `gradle2` deprecated (stage 2). Reader `gradle` removed.
* https://github.com/devonfw/solicitor/issues/285: VelocityWriter now enforces UTF-8 encoding when writing results.

Changes in 1.26.0::
Expand Down

0 comments on commit 6af82dc

Please sign in to comment.