[jakartaee-spec-project-leads] License files in javadoc and sources arti

[Joakim Erdfelt <joakim.erdfelt@xxxxxxxxx>]

Per the instructions at https://wiki.eclipse.org/How_to_Prepare_API_Projects_for_the_Jakarta_EE_8_Release

All of the jar artifacts produced should have an appropriate license file.

For the spec artiacts and javadoc artiacts it's the EFSL (Eclipse Foundation Specification License) - https://raw.githubusercontent.com/eclipse-ee4j/jakartaee-api/master/licenses/EFSL.html

For the rest of the artifacts (main artifact jar/bundle, and its sources classified jar) it's whatever that project is licensed at.

So for a typical jakarta project (with source) we'll have 3 artifacts for each maven module.

jakarta.<name>-<version>.jar - main artifact

jakarta.<name>-<version>-sources.jar - sources classified artifact

jakarta.<name>-<version>-javadoc.jar - javadoc classified artifact

Getting the license file into /META-INF/ for the main artifact is easy enough.

So is getting the license into the sources classified artifact.

However, getting the license into the javadoc classified artifact is a bit tricky.

I'm sure someone here has figured it out, but I can't find that project.

I sampled a few "done" projects on the "Jakarta EE 8 Release" project at https://github.com/orgs/eclipse-ee4j/projects/15

Here's what I found when searching sources classified artifacts from "Done" list ...

$ jar -tvf jakarta.security.enterprise-api-1.0.2-sources.jar | grep -Ei "(license|eclipse|efsl)"
$ jar -tvf jakarta.servlet-api-4.0.3-sources.jar | grep -Ei "(license|eclipse|efsl)"
$ jar -tvf jakarta.security.enterprise-api-1.0.2-sources.jar | grep -Ei "(license|eclipse|efsl)"
$ jar -tvf jakarta.inject-api-1.0-sources.jar | grep -Ei "(license|eclipse|efsl)"
$ jar -tvf jakarta.jms-api-2.0.3-sources.jar | grep -Ei "(license|eclipse|efsl)"
$ jar -tvf jakarta.json-api-1.1.6-sources.jar | grep -Ei "(license|eclipse|efsl)"
 35084 Fri Jul 19 19:29:04 CDT 2019 META-INF/LICENSE.md

Here's what I found when searching javadoc classified artifacts from "Done" list ...

$ jar -tvf jakarta.servlet-api-4.0.3-javadoc.jar | grep -Ei "(license|eclipse|efsl)"
$ jar -tvf jakarta.security.enterprise-api-1.0.2-javadoc.jar | grep -Ei "(license|eclipse|efsl)"
$ jar -tvf jakarta.inject-api-1.0-javadoc.jar | grep -Ei "(license|eclipse|efsl)"
$ jar -tvf jakarta.jms-api-2.0.3-javadoc.jar | grep -Ei "(license|eclipse|efsl)"
$ jar -tvf jakarta.json-api-1.1.6-javadoc.jar | grep -Ei "(license|eclipse|efsl)"
  3250 Fri Jul 19 19:35:18 CDT 2019 doc-files/speclicense.html

The json-api project has figured out how to get a license file into their javadoc classified jar, but not in the correct place.

But json-api did figure out how to get the /META-INF/LICENSE.md correctly.

I'm reaching out to find out if another project has figured this out yet for javadoc classified artifacts?

Thanks,

- Joakim Erdfelt (Jakarta WebSocket)