License reporting improvements
by Brian Stansberry
Kudos to Michal Petrov for the work he's been doing around license
reporting, and FYI to you all about it.
Apologies in advance if I get some of this wrong, but the gist of it is
Michal embedded the canonical information about how to describe licenses
within our licenses plugin itself.[1] This is the plugin we use to generate
the licenses.xml and licenses.html content users finds in docs/licenses in
a WildFly installation.
His work means a lot of the boilerplate we include in the source code for
our feature packs is no longer needed. See
https://github.com/wildfly/wildfly/pull/17278 for how much is no longer
needed.
https://issues.redhat.com/browse/WFLY-17755 is the JIRA that covers this.
I believe the effect of this is if a dev adds a new artifact to a feature
pack it is no longer required to add license data to our feature pack
source unless the artifact's associated pom doesn't have correct license
data. If you do need to add license info for the artifact, it's only
necessary to state the name of the license (one of the names listed in [1].)
If the "KnownLicenses" class in the plugin[1] doesn't have information
about a license, it's possible in the feature pack source to declare that
information and then reference it. See [2] as an example from the plugin
testsuite.
[1]
https://github.com/wildfly/licenses-plugin/commit/7d35dfeb161e47e6b034aa0...
[2]
https://github.com/wildfly/licenses-plugin/blob/main/src/it/insert-versio...
Thanks, Michal! This is a nice improvement that largely eliminates an
unintuitive boilerplate step when integrating new functionality.
Best regards,
Brian
2 years, 1 month
