devonfw guide

Initial version of experimental scancode integration. See Experimental Scancode Integration.

New decision table structure LicenseAssignmentV2 with additional condition origin. Old structure deprecated but still supported. Migrate existing project decision tables by renaming LicenseAssignmentProject.xls to LicenseAssignmentV2Project.xls and introducing a new (empty) column Origin between existing columns OSS Version and Declared License.

Added Solicitor Logo and code for creating variants / animation.

https://github.com/devonfw/solicitor/issues/117: New attribute packageUrl in ApplicationComponent.

Experimental scancode-toolkit integration changed to using Bash scripting.

Ruleset change: For GPL/LGPL-Licenses use …​-only or …​-or-later IDs instead of the deprecated ones like GPL-3.0.

https://github.com/devonfw/solicitor/issues/113: Allow project specific writers (additionalWriters) to be defined without overriding default writers.

https://github.com/devonfw/solicitor/issues/15: Enable Decision Tables to be alternatively defined as CSV. Allow dynamic determination of applicable format by specifying resource names without file extension.

https://github.com/devonfw/solicitor/issues/108: Updated spring boot framework, drools rule engine and other used components to latest versions.

https://github.com/devonfw/solicitor/issues/110: Allow an additional user guide to be extracted when using an extension.

New report ScancodeDownloadScript.vm to compile copyright information using ScanCode.

https://github.com/devonfw/solicitor/issues/75: Added license URL guessing, see Guessing of license URLs.

https://github.com/devonfw/solicitor/issues/86: In case that downloading content for a given URL fails no WARN message with stacktrace will be shown any more. Instead there will be an info message (SOLI-047 or SOLI-048) indicating that the content could not be downloaded. This change is due to the fact that failed downloads are expected - especially with the new feature license URL guessing.

Readers for PIP and YARN added.

https://github.com/devonfw/solicitor/issues/101: If downloaded license texts contain large amounts of html formatted content they will be replaced by a placeholder indicating the need for cleanup. A warning message will be written in this case (SOLI-050).

https://github.com/devonfw/solicitor/issues/103: Changed structure of Solicitor source code repository to maven multi module structure.

https://github.com/devonfw/solicitor/issues/7: Allow more flexible CSV file format within the CsvReader.

https://github.com/devonfw/solicitor/issues/78: Introduce new suffix (REGEX) in decision tables to mark regular expressions. Using this suffix avoids breaking any sorting when using mixed verbatim strings and regex patterns. The old prefix syntax REGEX: has been deprecated.

https://github.com/devonfw/solicitor/issues/97: Fixed the bug which made the GradleReader and GradleReader2 skip the first entry in the file.

https://github.com/devonfw/solicitor/issues/87: GradleReader and GradleReader2 no longer fail when reading files that contain no entry. Actually this was due to bug https://github.com/devonfw/solicitor/issues/97.

Fixed bug which resulted in corrupt XLS report due to cell comment exceeding maximum allowed size.

https://github.com/devonfw/solicitor/issues/94: Fixed by making sure that formulas get evaluated when opening the workbook with excel.

Fixed bug when reading saved data model for delta calculation. (repoType was not read correctly and resulted in always reporting a difference.)

Added some license name mapping rules in LicenseNameMappingSample.xls.

https://github.com/devonfw/solicitor/issues/71: New "Quality Report" which might be helpful in validating the outcome of the Solicitor run. Currently this report contains a list of all application components which have more than one effective license attached. This might be helpful for spotting cases where appropriate rules for selecting the applicable license in case of dual-/multilicensing is missing.

Corrected order of license name mapping which prevented Unlicense, The W3C License, WTFPL, Zlib and Zope Public License 2.1 to be mapped.

https://github.com/devonfw/solicitor/issues/67: Inclusion of detailed license information for the dependencies included in the executable JAR. Use the '-eug' command line option to store this file (together with a copy of the user guide) in the current work directory.

Additional rules for license name mappings in decision table LicenseNameMappingSample.xls.

https://github.com/devonfw/solicitor/pull/61: Solicitor can now run with Java 8 or Java 11.

https://github.com/devonfw/solicitor/issues/62: New Reader of type npm-license-checker for reading component/license data collected by NPM License Checker (https://www.npmjs.com/package/license-checker). The type of the existing Reader for reading CSV data from the NPM License Crawler has been changed from npm to npm-license-crawler-csv. (npm is still available but deprecated.) Projects should adopt their Reader configuration and replace type npm by npm-license-crawler-csv.

https://github.com/devonfw/solicitor/issues/56: Enable continuing analysis in multiapplication projects even is some license files are unavailable.

Described simplified usage of license-maven-plugin without need to change pom.xml. (Documentation only)

Ensure consistent sorting even in case that multiple "Ignored" licenses exist for a component