github-api: Potential problem from lack of modular declaration for github-api jar file

This project I’m working on, I intend to publish to a public repository at some point … I ran a Maven verify goal on my project and it came back with this warning:

[WARNING] ******************************************************************************************************************************************************************
[WARNING] * Required filename-based automodules detected: [github-api-1.301.jar]. Please don't publish this project to a public artifact repository! *
[WARNING] ******************************************************************************************************************************************************************

When I looked into the warning, apparently this is considered somewhat serious as it is caused by the library not having a module declaration, where a module declaration remains unchanged in future releases of an artifact where the filename does change. But as it is now, apparently that jar file lacks a module declaration so the module is declared automatically based on the filename.

This can cause problems for projects that depend on other artifacts that also depend on the Git-Hub API when they might depend on two or more and their dependencies on this API have different names. And a project that has such a dependency structure will be unable to run, and fixing it is not an easy proposition… so I guess the rule of thumb is to not publish projects that have dependencies with auto-generated module declarations.

So my question is:

Will you be declaring a module for the Git-Hub API so that this isn’t a problem when publishing projects that depend on it?

I realize this means that the API would need to be modularized … but surely this shouldn’t be that much of a bid deal?

Unless my assumptions on this are incorrect and this warning has a more… sinister cause? As in … something is broken or I’m implementing the API into my project incorrectly?

About this issue

  • Original URL
  • State: closed
  • Created 3 years ago
  • Comments: 15 (15 by maintainers)

Commits related to this issue

Most upvoted comments

@bitwiseman Since you compile with Java 11, I’m pretty sure my last statement about incompatibility with 1.8 becomes non-issue… I bought and am now reading this book … currently in chapter 4 hope to be done within a couple of days … if I don’t have a firm grip on modular coding in Java by the time I finish it, I’ll join the circus.