devonfw / solicitor

Solicitor is a tool enabling management of licenses of software dependencies
Apache License 2.0
22 stars 18 forks source link

Enable more fine granular definition of curations #262

Closed ohecker closed 3 months ago

ohecker commented 4 months ago

Overview

As somebody responsible for creating curations I want to have the possibility to write curations in a way that allow the removal and addition of single licenses and copyright entries instead of having to redefine the list of licenses or copyright entries completely. While this possibility does not directly give a benefit when curating a single component it enables to easier transfer curations e.g. to other versions of the the same component.

Proposal of approach for ADD/DELETE operations

The given approach works on the Scancode input data. This introduces some coupling to the scancode data model but avoids coupling to the ComponentInfo data model. Working on the input data model gives some fine granular control and enables to write curations rules which avoid being triggered to broadly.

DELETE of Licenses

Deleting found licenses is done by defining rules which result in ignoring the license finding(s) of scancode rules in files within the scanned codebase. The following "conditions" are used for defining the rule

This kind of curations is independent of the ComponentInfo data model but introduces a coupling to the scancode data model / rules.

ADD of License

Adding new licenses is done by defining rules which add new license info (to the licenses found in a source file) - or "on top level".

Conditions:

Data:

DELETE of Copyrights

Deleting found copyrights is done by defining rules which result in ignoring the copyright finding(s) in files within the scanned codebase. The following "conditions" are used for defining the rule

ADD of Copyright

Adding new copyrights is done by defining rules which add new copyright info (to the copyrights found in a source file) - or "on top level".

Conditions:

Data:

Acceptance criteria

ohecker commented 3 months ago

This story is a duplicate (and superseded) by #267. Closing it now.