Skip to content

Adding Javadoc and sources jar to build/publish#12

Merged
reportmill merged 2 commits into
reportmill:masterfrom
Smithor:Feature-BuildJavadocAndSourcesJars
May 27, 2026
Merged

Adding Javadoc and sources jar to build/publish#12
reportmill merged 2 commits into
reportmill:masterfrom
Smithor:Feature-BuildJavadocAndSourcesJars

Conversation

@Smithor
Copy link
Copy Markdown
Contributor

@Smithor Smithor commented Feb 13, 2026

Super simple addition to the build script to build the javadoc and sources. This one doesn't need to be added if you do not want it, but I am running it on my local copy so that I don't have to keep the SnapKit project open all the time.

  • Add generation of Javadoc and sources jars so that they can be included at publish time.
  • Fixed a Gradle duplications problem with building the sources jar.

@Smithor
Copy link
Copy Markdown
Contributor Author

Smithor commented Mar 16, 2026

I would like this one merged, as it makes the writing of javadocs easier in IntelliJ. IntelliJ uses the source jar to copy the javadocs from, and also builds its internal javadoc reader from that source.

I honestly hardly leave the IDE, its just so convenient, but it only works fully if all the data is provided. Technically the javadoc jar isn't required for this, but having all options available is favourable, especially since it costs nothing.

@Smithor
Copy link
Copy Markdown
Contributor Author

Smithor commented May 22, 2026

Any interest in this one? It's not a mission critical one, but it is a standard one to include in a library. I've honestly never seen a library not include these jars. Without it, users will need to keep a copy of the project open in order to follow along, as well as manage their own builds. It was the reason for #11, I just had it in a separate pull request at the time since I wasn't sure if you liked pull requests being large or small at the time.

@reportmill
Copy link
Copy Markdown
Owner

Sorry for the delay! I've been out of town for a week and just now digging myself out. This sounds really good - I'll get to your work this week and try to take some action.

…ed at publish time.

Fixed a Gradle duplications problem.
@Smithor Smithor force-pushed the Feature-BuildJavadocAndSourcesJars branch from 6738f9c to 5652272 Compare May 26, 2026 21:45
@Smithor
Copy link
Copy Markdown
Contributor Author

Smithor commented May 26, 2026

No worries, I've been busy myself. Pulled away for other tasks for over 2 months.

Removed merge commit that I slipped in by accident.

@reportmill reportmill merged commit e66764d into reportmill:master May 27, 2026
@reportmill
Copy link
Copy Markdown
Owner

This should be a nice addition! I was kind of oblivious because I'm always working on the source. :-)

@Smithor Smithor deleted the Feature-BuildJavadocAndSourcesJars branch May 27, 2026 16:44
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

Successfully merging this pull request may close these issues.

2 participants