search

OpenLiberty / ci.maven

Maven plugins for managing Liberty profile servers #devops
Apache License 2.0
130 stars 91 forks source link

Update documentation to disclose binary scanner license #1552

Open TrevCraw opened 2 years ago

TrevCraw commented 2 years ago

Disclose dependency on IBM WebSphere Application Server Migration Toolkit for Application Binaries which is separately licensed under ILAN. Share link to the public ILAN license: https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt/en.html

Update the following doc pages:

Add binary scanner as "runtime dependency" on Maven Central for the build plugins:

DoloresLopez commented 2 years ago

Hello @TrevCraw can this issue be closed? If not, what else is needed

cherylking commented 2 years ago

@TrevCraw For this part:

Add binary scanner as "runtime dependency" on Maven Central for the build plugins:

I think it means adding a runtime dependency in the pom.xml/build.gradle so that it is documented that it is a dependency, even though it is not needed for compilation. We would need to make sure that it does not get bundled in the plugin jar though.

TrevCraw commented 2 years ago

The following doc pages have been updated:

LMP README: https://github.com/OpenLiberty/ci.maven Dev mode (Maven): https://github.com/OpenLiberty/ci.maven/blob/main/docs/dev.md Generate features (Maven): https://github.com/OpenLiberty/ci.maven/blob/main/docs/generate-features.md LGP README: https://github.com/OpenLiberty/ci.gradle Dev mode (Gradle): https://github.com/OpenLiberty/ci.gradle/blob/main/docs/libertyDev.md Generate features (Gradle): https://github.com/OpenLiberty/ci.gradle/blob/main/docs/generateFeatures.md

An issue has been opened to address updating the Open Liberty docs dev mode page: https://github.com/OpenLiberty/docs/issues/5828

Figuring out how to add binary scanner as a dependency on Maven Central will be addressed at a later date.

cherylking commented 2 years ago

Just wanted to note here that I tried adding the dependency as a runtime dependency in the pom.xml and it caused the binary scanner to get downloaded every single time any goal was run on the Liberty Maven Plugin. That is not desirable or acceptable. I also tried adding the <optional>true</optional> config to the runtime dependency and it had no affect. We could consider listing it as a provided dependency but that is a bit misleading.

Whatever we decide to do, it needs to not have a detrimental affect to the performance of the plugin.