Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Maven Java sources and javadoc artifacts #333

Closed
fulghum opened this issue Jul 12, 2018 · 3 comments
Closed

Maven Java sources and javadoc artifacts #333

fulghum opened this issue Jul 12, 2018 · 3 comments

Comments

@fulghum
Copy link
Contributor

fulghum commented Jul 12, 2018

I see the class library exposed in the Maven artifacts, but I don't see a sources or javadoc jar. It would be awesome to build these and include them with the Maven artifacts so that IDEs can automatically pick up source attachment and documentation.

ex: https://maven.apache.org/plugin-developers/cookbook/attach-source-javadoc-artifacts.html

@eladb
Copy link
Contributor

eladb commented Jul 16, 2018

Odd... We have source artifacts in the maven packages. Here's the list of files:

aws-cdk-0.7.3-beta-sources.jar
aws-cdk-0.7.3-beta-sources.jar.md5
aws-cdk-0.7.3-beta-sources.jar.sha1
aws-cdk-0.7.3-beta.jar
aws-cdk-0.7.3-beta.jar.md5
aws-cdk-0.7.3-beta.jar.sha1
aws-cdk-0.7.3-beta.pom
aws-cdk-0.7.3-beta.pom.md5
aws-cdk-0.7.3-beta.pom.sha1

But when I am checking in my IDE, you are right, it doesn't find the sources.
Need to dive deeper.

Regarding javadocs, we should add I guess. I was thinking that if the sources contain javadocs, the IDE should be able to render them, but I guess the best practice is to include javadocs...

@eladb
Copy link
Contributor

eladb commented Jul 16, 2018

@RomainMuller since you are working on #111 which will change the way we produce POM files, maybe you can take a look at this one too...

@eladb
Copy link
Contributor

eladb commented Aug 29, 2018

Fixed

@eladb eladb closed this as completed Aug 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants