使用GitHub，Sonatype Maven repo提供JavaDocs

Question

尽管Github为Java开源项目提供了一个很好的家，但与更成熟的开源托管位置相比，仍有一些东西仍然缺失。到目前为止，我已经发现Sonatype为开源项目提供了Maven存储库访问，这解决了一个问题;用户/ dev邮件列表有很多解决方案。

但我现在要解决的一件事是发布自动生成的javadocs以进行在线浏览。虽然通过Maven发布源代码jar对IDE有所帮助，但我仍然希望能够在线浏览javadoc而无需下载或导入项目。对于在Github上托管的项目，是否有人知道实现这一目标的好方法？ （不一定是Github提供的东西，但理想情况下，当发布被削减时可以实现自动化的东西）

Answer 1

GitHub提供位于gh-pages的回购邮件的http://your_username.github.com/your_repo/分支中的静态HTML文件。从理论上讲，Maven可以做到以下几点：

1. 提交发布pom.xml。
2. 将JavaDocs生成到.gitignore'd目录（因此它将在分支更改中保留）。
3. 结帐gh-pages分行。
4. 将工作目录中的所有文件替换为JavaDocs复制到
的目录
5. 提交
6. 查看原始分支。
7. 继续发布......

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

Answer 2

现在有一个Maven插件可以将目录推送到githib上的特定分支：http://github.com/github/maven-plugins。

Answer 3

您可以使用shell脚本执行Jake Wharton建议的git checkout / add / commit / checkout / push，并配置Ant或Gradle在生成javadoc后运行shell脚本。我不确定这适用于Maven。这是一个example shell script。

Answer 4

你可以使用github页面，创建一个静态网站，然后将你的javadoc放在一个目录中并提交给gh-pages分支。

查看Git中心页面，它简单实用。

见

http://readwrite.com/2013/11/27/github-pages-explained#awesm=~oII5EQELsqV6S7