You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2024/10/22 21:26:00 UTC
[jira] [Commented] (MJAVADOC-329) Allow generation of empty Javadoc JARs
[ https://issues.apache.org/jira/browse/MJAVADOC-329?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17891997#comment-17891997 ]
ASF GitHub Bot commented on MJAVADOC-329:
-----------------------------------------
michael-o opened a new pull request, #331:
URL: https://github.com/apache/maven-javadoc-plugin/pull/331
Following this checklist to help us incorporate your
contribution quickly and easily:
- [ ] Make sure there is a [JIRA issue](https://issues.apache.org/jira/browse/MJAVADOC) filed
for the change (usually before you start working on it). Trivial changes like typos do not
require a JIRA issue. Your pull request should address just this issue, without
pulling in other changes.
- [ ] Each commit in the pull request should have a meaningful subject line and body.
- [ ] Format the pull request title like `[MJAVADOC-XXX] - Fixes bug in ApproximateQuantiles`,
where you replace `MJAVADOC-XXX` with the appropriate JIRA issue. Best practice
is to use the JIRA issue title in the pull request title and in the first line of the
commit message.
- [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [ ] Run `mvn clean verify -Prun-its` to make sure basic checks pass. A more thorough check will
be performed on your pull request automatically.
If your pull request is about ~20 lines of code you don't need to sign an
[Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- [ ] I hereby declare this contribution to be licensed under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
- [ ] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
> Allow generation of empty Javadoc JARs
> --------------------------------------
>
> Key: MJAVADOC-329
> URL: https://issues.apache.org/jira/browse/MJAVADOC-329
> Project: Maven Javadoc Plugin
> Issue Type: Improvement
> Affects Versions: 2.8
> Reporter: Vincent Massol
> Assignee: Michael Osipov
> Priority: Major
> Fix For: 3.11.0
>
>
> Here's my use case:
> * I want to be able to deploy my artifacts to Maven Central. There's a requirement that a javadoc jar exists for the arifact to deploy
> * However I have some maven modules of type packaging = jar that have java files but these files are located in an "internal" package (internal api that we don't expose to end users since it's not part of our public API contract) which we exclude from the javadoc generation
> The problem is that the javadoc plugin doesn't generate any JAR if there are no java files matching (even if I have other files such as a package.html file in my src/main/javadoc/* directories).
> I'd like it to be possible to generate an "empty" javadoc JAR containing only a package.html file for example.
> Thanks a lot
--
This message was sent by Atlassian Jira
(v8.20.10#820010)