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

Add an Automatic-Module-Name manifest entry #39

Closed
varunnvs92 opened this issue May 30, 2018 · 5 comments
Closed

Add an Automatic-Module-Name manifest entry #39

varunnvs92 opened this issue May 30, 2018 · 5 comments

Comments

@varunnvs92
Copy link
Contributor

varunnvs92 commented May 30, 2018

It is recommended for java libraries in public repositories like Maven Central to add Automatic-Module-Name manifest entry. This allows the consumers of the library to move to Java 9 modularization and depend on the Automatic-Module-Name value instead of the name derived from the Jar file. This way, your consumers won't need to make changes when your library is eventually converted to a Java 9 module.

Adding Automatic-Module-Name doesn't affect any code and will simply make a name reservation until an actual module-info.java will be added eventually. More details can be found in this article.

As for the module name, I think com.typesafe.netty seems reasonable. This article has best naming practices for JPMS modules.

AWS Java SDK v2 has a dependency on your library and we are adding module-info files to our library. But we need this change to be done before we can add move to JPMS. I can create a PR if you think it would be helpful to prioritize this request.

@schmitch
Copy link
Contributor

actually I think we could even add a module-info directly.

@varunnvs92
Copy link
Contributor Author

Thanks, that would be great. Do you have a timeline in mind?

@varunnvs92
Copy link
Contributor Author

varunnvs92 commented Jun 4, 2018

@schmitch
Any updates on this? I can send the PR for adding the "Automatic-Module-Name" header.

But if you want to add module-info file, then it would make sense for your team to work on it as you would know better on which packages you want to export and which packages you want to hide etc.

@schmitch
Copy link
Contributor

schmitch commented Jun 4, 2018

well you can just create a PR with the Automatic-Module-Name header.

@varunnvs92
Copy link
Contributor Author

When do you plan to release a new version to Maven that has this change?

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