search

sofastack / sofa-boot

SOFABoot is a framework that enhances Spring Boot and fully compatible with it, provides readiness check, class isolation, etc.
https://www.sofastack.tech/sofa-boot/docs/Home
Apache License 2.0
4.97k stars 1.27k forks source link

MAC OSX下MAVEN生成javadoc报错 #133

Closed chenhui0212 closed 6 years ago

chenhui0212 commented 6 years ago

报错说明

在OSX系统下IDEA中执行 sofa-boot-runtime 项目的 mvn install 命令，报如下错误：

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:jar (attach-javadocs) on project infra-sofa-boot-starter: MavenReportException: Error while creating archive: Unable to find javadoc command: The environment variable JAVA_HOME is not correctly set. -> [Help 1]

问题研究

去网上查询解决方法，发现大多和 maven-javadoc-plugin 2.9.x 版本相关，以下是stack overflow上的相关讨论：

JAVA_HOME on OSX with Eclipse and Maven

自己尝试了以下两种方式，都不再报错：

  1. 在 pom.xml 文件的 properties 属性中添加以下配置： <javadocExecutable>${java.home}/../bin/javadoc</javadocExecutable>
  2. 升级 maven-javadoc-plugin 版本到 2.10.1 及以上。

猜测可能是该插件 2.9.x 版本存在的bug，尝试去查询该插件之后的提交说明，但是没有找到明确相关的说明，在这反馈一下这个问题。

执行环境：

QilongZhang commented 6 years ago

@chenhui0212 感谢反馈，虽然在本地尝试没能复现你的问题，不过插件 2.9.x 应该是存在一些问题。如果可以，期待你 PR 升级 maven-javadoc-plugin 版本至 2.10.1