使JavaDocs可用于GitHub、Sonatype Maven存储库

Question

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

但我现在正在尝试解决的一件事是发布自动生成的javadoc以供在线浏览。尽管通过Maven发布源代码jars对IDE有一点帮助，但我仍然喜欢无需下载或导入项目就能在线浏览javadoc的功能。对于Github托管的项目，有没有人知道实现这一点的好方法？(不需要是Github提供的东西，但理想情况下是可以在版本削减时自动发生的东西)

Answer 1

GitHub提供静态的超文本标记语言文件，这些文件位于http://your_username.github.com/your_repo/上的存储库的gh-pages分支中。从理论上讲，Maven可以执行以下操作：

将release pom.xml.

• Generate .gitignore

1. JavaDocs提交到.gitignore'd目录(因此，它将跨分支保留，并保留工作目录中的所有文件和gh-pages JavaDocs已拷贝到的目录的文件...

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

Answer 2

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

Answer 3

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