通过每次推送在GitLab上创建JavaDoc

时间:2019-07-10 08:10:36

标签: java maven gitlab javadoc maven-javadoc-plugin

我正在研究一个在GitLab上运行的Java项目。我正在尝试找到一种方法,GitLab在每次推送时都会自动生成Java文档。

我试图将JavaDoc插件用于Maven,并使用管道对其进行调用。但是该插件需要文件 javadoc.exe ,该文件仅在我的计算机本地,而不在GitLab。

是否可以在没有此文件的情况下运行插件。或者也许是解决这个问题的另一种选择?

谢谢!

1 个答案:

答案 0 :(得分: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

查看文档:{​​{3}}

证明:

$ 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 ...