ci.maven icon indicating copy to clipboard operation
ci.maven copied to clipboard

Update documentation to disclose binary scanner license

Open TrevCraw opened this issue 3 years ago • 4 comments

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:

  • [x] LMP README: https://github.com/OpenLiberty/ci.maven
  • [x] Dev mode (Maven): https://github.com/OpenLiberty/ci.maven/blob/main/docs/dev.md
  • [x] Generate features (Maven): https://github.com/OpenLiberty/ci.maven/blob/main/docs/generate-features.md
  • [x] LGP README: https://github.com/OpenLiberty/ci.gradle
  • [x] Dev mode (Gradle): https://github.com/OpenLiberty/ci.gradle/blob/main/docs/libertyDev.md
  • [x] Generate features (Gradle): https://github.com/OpenLiberty/ci.gradle/blob/main/docs/generateFeatures.md
  • [ ] Open Liberty docs dev mode page: https://openliberty.io/docs/latest/development-mode.html

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

  • [ ] LMP - https://mvnrepository.com/artifact/io.openliberty.tools/liberty-maven-plugin/3.6
  • [ ] LGP - https://mvnrepository.com/artifact/io.openliberty.tools/liberty-gradle-plugin/3.4

TrevCraw avatar Jun 16 '22 18:06 TrevCraw

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

DoloresLopez avatar Sep 15 '22 13:09 DoloresLopez

@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.

cherylking avatar Sep 19 '22 17:09 cherylking

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.

TrevCraw avatar Sep 30 '22 20:09 TrevCraw

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.

cherylking avatar Sep 30 '22 20:09 cherylking