java - 通过每次 Push 在 GitLab 上创建 JavaDoc

Question

我正在开发一个在 GitLab 上运行的 Java 项目。我正在尝试找到一种方法，让 GitLab 在每次推送时自动生成 Java 文档。

我尝试使用 Maven 的 JavaDoc 插件并使用管道调用它。但是插件需要文件 javadoc.exe，它只是在我的本地计算机上，而不是在 GitLab 上。

是否可以在没有此文件的情况下运行插件。或者可能有其他选择来解决这个问题？

谢谢!

Answer 1

选项 1. 使用包含 javadoc 的 JDK 镜像

证明:

$ docker run -it --rm openjdk javadoc --version
javadoc 12.0.1

GitLab CI 作业示例:

generate-doc:
  image: openjdk
  script:
    - javadoc ...

选项2.通过npm安装javadoc

参见文档:https://www.npmjs.com/package/javadoc

证明:

$ npm install -s javadoc
+ javadoc@1.0.6
added 235 packages from 100 contributors and audited 81 packages in 8.795s
found 0 vulnerabilities

$ javadoc --version
javadoc 12.0.1

GitLab CI 作业示例:

generate-doc:
  image: node
  script:
    - npm install -s javadoc
    - javadoc ...