如何使用 EGit 和 Eclipse 将 JavaDoc 从 master 分支移动到 GitHub 上的 gh-pages 分支？答案

【问题标题】：How I can move JavaDoc from master branch to gh-pages branch on GitHub using EGit and Eclipse?如何使用 EGit 和 Eclipse 将 JavaDoc 从 master 分支移动到 GitHub 上的 gh-pages 分支？
【发布时间】：2020-03-05 21:27:05
【问题描述】：

我有一个托管在 GitHub 上的 java 项目。我想允许查看此托管的 JavaDoc HTML 页面。为此，我创建了gh-pahes 分支。

我如何轻松使用 EGit 和 Eclipse IDE 将 JavaDoc（创建到 master 分支）移动/提交到 gh-pages 分支？我经常重新生成 JavaDoc，并希望找到方法将新版本的 JavaDoc 轻松提交到 gh-pages，但在 master 分支中工作。

【问题讨论】：

标签： java github javadoc

【解决方案1】：

这不在 Eclipse 中，但这是我在命令行中进行移动的方式，而无需第二次克隆 repo。首先，我将我的 javadoc 插件配置为在我的 pom.xml 中使用它在我的项目目录中的文件夹“apidocs”中生成文档

<build>
  <plugins>
     ...
     <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.10.3</version>
        <configuration>
          <reportOutputDirectory>apidocs</reportOutputDirectory>
        </configuration>
      </plugin>
      ...

然后我将“apidocs”添加到我的 .gitignore 中。然后为了制作和移动 javadocs，我执行以下操作 - 从 master 开始：

mvn javadoc:javadoc
tar cfv apidocs.tar apidocs
git checkout gh-branches
tar xfv apidocs.tar
git commit -a
git push
rm apidocs.tar
git checkout master

诀窍在于 tar 文件（永远不会出现在 repo 中）确实在分支之间的切换中仍然存在 - 而当我切换分支时，文件夹层次结构中 apidocs 文件的更改似乎消失了。

当我切换回 master 时很好 - apidocs 文件夹不见了。

【讨论】：

它有用的解决方案。非常感谢！
我猜你是 gh-pages 而不是 gh-branches ？

【解决方案2】：

我建议您使用已签出gh-pages 分支的存储库的第二个克隆。然后，您可以轻松地移动和提交生成的文件，而无需在 master 和 gh-pages 分支之间切换。

【讨论】：

【解决方案3】：

我发现不是我想要的那么好的解决方案，但它是有效的：

在 GitHub 中创建 gh-pages 分支。
结帐此分支。
从 gh-pages 切换到 master 并生成 javadoc。
提交 javadocs。
从 master 切换到 gh-pages 分支。
您可以看到 gh-pages 分支包含 javadoc 文件夹。
只需将此文件夹提交到 gh-pages。
了解如何更新！

如何更新：

在master分支删除所有javadoc目录并重新生成javadoc。
仅提交生成的javadoc！。
从 master 切换到 gh-pages 分支。
删除旧的 javadoc 并提交此更改！
右键单击您的项目并选择团队 -> 在历史中显示。
发现您使用 master 分支中的 javadoc 提交。
右键单击此提交并选择 Cherry Pick。

仅此而已！现在你从 master 分支副本提交到 gh-pages 分支！

我不知道为什么我需要使用特殊分支来访问我在 GitHub 中的 HTML 文档？！使用 Google 代码更多很有用！

【讨论】：