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

时间:2012-08-13 16:18:21

标签: java github javadoc

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

如何使用EGit和Eclipse IDE 轻松将JavaDoc(创建到master分支中)移动/提交到gh-pages分支?我经常重新生成JavaDoc,并希望找到方法将新版JavaDoc轻松提交到gh-pages,但是可以使用master分支。

3 个答案:

答案 0 :(得分:1)

这不是在Eclipse中,但这是我在没有repo的第二个克隆的情况下在命令行中移动的方式。首先,我配置我的javadoc插件以生成文件夹中的文档" apidocs"在我的项目目录中使用我的pom.xml

<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>
      ...

然后我添加&#34; apidocs&#34;我的.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文件的更改消失了。

当我切换回主人时很好 - apidocs文件夹已经消失了。

答案 1 :(得分:0)

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

答案 2 :(得分:0)

我发现并不是我想要的解决方案,但它确实有效:

  1. 在GitHub中创建 gh-pages 分支。
  2. 结帐此分行。
  3. gh-pages 切换到 master 并生成 javadoc
  4. 提交 javadocs
  5. 切换到 gh-pages 分支。
  6. 您可以看到 gh-pages 分支包含 javadoc 文件夹。
  7. 只需将此文件夹提交到 gh-pages
  8. 了解如何更新!
  9. 如何更新:

    1. 分支删除所有 javadoc 目录重新生成 javadoc 。< / LI>
    2. 提交 olny生成 javadocs
    3. 切换到 gh-pages 分支。
    4. 删除旧的 javadoc 并提交此更改!
    5. 右键点击您的项目,然后选择团队 - &gt; 在历史中显示
    6. 发现您使用 master 分支中的 javadoc 进行提交。
    7. 右键点击此提交,然后选择 Cherry Pick
    8. 多数民众赞成!现在您从分支副本提交到 gh-pages 分支!

      我不知道为什么我需要使用特殊分支来访问GitHub中的HTML文档?!使用Google代码 MORE 非常有用!