通过 GitHub、Sonatype Maven 存储库提供 JavaDocs [关闭]答案

【问题标题】：Making JavaDocs available with GitHub, Sonatype Maven repo [closed]通过 GitHub、Sonatype Maven 存储库提供 JavaDocs [关闭]
【发布时间】：2011-04-25 18:32:22
【问题描述】：

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

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

【问题讨论】：

标签： java open-source github javadoc

【解决方案1】：

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

提交版本pom.xml。
将 JavaDocs 生成到 .gitignore'd 目录中（以便在分支更改时保留它）。
查看gh-pages 分支。
将工作目录中的所有文件替换为 JavaDocs 复制到的目录中的文件
提交
签出原始分支。
继续发布...

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

【讨论】：

谢谢，这是个好主意，可以很好地工作。
FWIW，即使没有更多的自动化，这也工作得很好。我只是做'mvn install'，将'target/apidocs'重命名为'javadoc/[VERSION]'，'git add'提交，就是这样。
仅供参考，我现在使用的是 khuxtable.github.com/wagon-gitsite，它可以完全自动将站点部署到 gh-pages 分支。
对于我的jsch-documentation-project，我使用git-new-workdir 来创建第二个带有gh-pages 分支的工作目录，以及一个将javadocs 放入该目录的符号链接。但是，没有自动提交和推送。
我很抱歉跑题了，但出于安全原因，GitHub 不允许在 gh-pages 网络服务器中设置框架。但是，javadocs 视图包含 3 个框架。你找到解决办法了吗？

【解决方案2】：

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

【讨论】：

【解决方案3】：

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

【讨论】：

【解决方案4】：

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

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

见

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

【讨论】：