java - 通过 GitHub、Sonatype Maven 存储库使 JavaDocs 可用

Question

虽然 Github 为 Java 开源项目提供了一个不错的归宿，但与更成熟的开源托管场所相比，仍然缺少一些东西。到目前为止，我发现 Sonatype 为开源项目提供 Maven 存储库访问，这解决了一个问题；并且有许多针对用户/开发者邮件列表的解决方案。

但我现在要解决的一件事是发布自动生成的 javadocs 以供在线浏览。尽管通过 Maven 发布源 jars 对 IDE 有一些帮助，但我仍然喜欢在线浏览 javadocs 而无需下载或导入项目的能力。对于托管在 Github 上的项目，有谁知道实现这一目标的好方法？ (不必是 Github 提供的东西，但理想情况下可以在发布被切断时自动发生)

Answer 1

GitHub 提供位于 http://your_username.github.com/your_repo/ 的 repo 的 gh-pages 分支中的静态 HTML 文件。理论上，Maven 可以做以下事情:

1. 提交发布pom.xml。
2. 将 JavaDocs 生成到 .gitignore 的目录中(以便在分支更改时保留它)。
3. checkout gh-pages 分支。
4. 将工作目录中的所有文件替换为 JavaDocs 复制到的目录中的文件
5. 提交
6. checkout 原始分支。
7. 继续发布...

我只有两天时间才能将 Maven 用于我的一些项目，所以这超出了我的能力范围。我很想看到使用现有插件或自定义插件实现这一点。