使用GitHub提供JavaDocs,Sonatype Maven repo

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

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

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

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

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

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

你可以像Jake Wharton建议的那样使用shell脚本来执行git checkout / add / commit / checkout / push,并在生成javadoc之后配置Ant或Gradle来运行shell脚本。 我不确定这适用于Maven。 这是一个示例shell脚本 。

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

看到Git中心页面,它简单实用。

看到

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