一尘不染

使JavaDocs在GitHub和Sonatype Maven存储库中可用

java

尽管Github为Java开源项目提供了一个不错的家,但与更成熟的开源托管场所相比,仍有一些地方缺少。到目前为止,我已经发现Sonatype为开源项目提供了Maven存储库访问权限,从而解决了一个问题。用户/开发邮件列表有很多解决方案。

但是我现在要解决的一件事是发布自动生成的javadocs进行在线浏览。尽管通过Maven发布源jar可以帮助IDE有所帮助,但我仍然喜欢无需下载或导入项目即可在线浏览javadocs的功能。有人知道在Github托管的项目中实现此目标的好方法吗?(不一定是Github提供的功能,但理想情况下,可以在发布时自动进行操作)


阅读 222

收藏
2020-12-03

共1个答案

一尘不染

GitHub提供静态HTML文件,这些文件位于gh- pages您的repo分支中http://your_username.github.com/your_repo/。从理论上讲,可以使Maven做到以下几点:

  1. 提交发布pom.xml
  2. 将JavaDocs生成到一个.gitignore‘d目录(以便在分支更改时将其保留)。
  3. 结帐gh-pages分支。
  4. 将工作目录中的所有文件替换为JavaDocs复制到的目录中的所有文件
  5. 承诺
  6. 签出原始分支。
  7. 继续发布…

我仅用两天的时间就可以在一些项目中使用Maven,所以这超出了我的能力范围。我很想看到使用现有插件或自定义插件实现的方法。

2020-12-03