GitHub を使用した共同作業

ここでは、GitHub を使用して RoboHelp で共同作業を行う方法について説明します。

GitHub に接続するための前提条件

  1. GitHub をシステムにインストールします。 インストールの手順について詳しくは、GitHub インストールページを参照してください。 
  2. GitHub をシステムパスに追加します。
  3. システムで GitHub を設定します。 手順について詳しくは、GitHub ヘルプを参照してください。

GitHub 接続プロファイルの作成

RoboHelp と GitHub を接続するには、GitHub 接続プロファイルを作成します。

  1. RoboHelp を開きます。

  2. 共同作業/新規接続を選択します。

  3. 接続プロファイルダイアログボックスで、接続プロファイルの名前を指定します。

  4. バージョンコントロール」ドロップダウンリストで「Git」を選択します。

  5. リポジトリ SSH URL」フィールドで、リポジトリ SSH URL を以下の形式で指定します。

    git@<servername>:<orgName/repoName>.git

  6. ブランチ」フィールドで、ブランチ名(「master」など)を指定します。

  7. SSH 秘密鍵」フィールドで、GitHub リポジトリにリンクされている SSH キーのパスを指定するか、SSH キーのパスに移動します。

    SSH キーを作成する場合は、GitHub ヘルプを参照してください。 

    注意:

    SSH キーを作成しているときは、パラフレーズを追加しないでください。 パスワードが設定されたキーには既知の問題があります。これは次の更新で修正される予定です。

    SSH キーを作成、追加した後、SSH 接続をテストします。 詳しくは、GitHub ヘルプを参照してください。

    SSH キーが正常に追加されたことを示すメッセージが、画面の右下隅に表示されます。

  8. ローカルパス」フィールドで、プロジェクトパスを指定します。

    以下のシナリオに応じてプロジェクトパスは異なります。

    • GitHub にプロジェクトを追加する:バージョンをコントロールするため、GitHub リポジトリに追加するプロジェクトのパスを指定します。
    • 接続を開く:ローカルで GitHub プロジェクトのクローンを作成する際に保存先とする空のローカルフォルダーのパスを指定します。
  9. 保存」をクリックします。

RoboHelp プロジェクトの GitHub への追加

  1. GitHub に追加するプロジェクトを開きます。 これは、GitHub 接続の作成中に指定したプロジェクトパスのプロジェクトです。詳しくは、「GitHub 接続の作成」の手順 8 を参照してください。

  2. 共同作業/プロジェクトを追加/<プロファイル名>を選択します。

  3. コミットダイアログボックスで、「Git バージョンコントロール」フィールドに追加するファイルを選択します。

  4. コミットの説明」フィールドで、説明を入力します。

  5. コミット」をクリックします。

  6. ファイルを GitHub リポジトリにプッシュするには、「プッシュ」をクリックします。

    RoboHelp プロジェクトが GitHub リポジトリに追加されます。 RoboHelp プロジェクトと GitHub リポジトリ間で変更のコミットを開始できます。

  7. 変更をプッシュするには:

    1. プロジェクトで必要な変更を行います。

    2. 共同作業/コミットを選択します。

    3. コミットするファイルを選択し、コミットの説明を入力します。

    4. コミット」をクリックします。

    5. 変更を GitHub リポジトリにプッシュするには、共同作業/プッシュを選択します。

  8. GitHub リポジトリの変更をローカルプロジェクトに同期するには、共同作業/プルを選択します。

  9. ファイルをプッシュした後に以下のメッセージが表示される場合は、ファイルでマージの競合が発生しています。

    「現在のブランチの先端は、リモートブランチの後ろにあります。 プッシュする前にプルを試行してみてください」 

    同じファイルで変更を行う場合に競合をマージするには:

    前提条件:

    1. 編集/環境設定/バージョンコントロールを選択します。 
    2. 外部差異 / マージアプリケーションの .exe ファイルのパスを入力します。
    1. 共同作業/プルを選択します。 以下のメッセージが表示されます。
      「ローカルで行われた変更はリモートブランチで行われた変更と競合しています。競合を解決してコミットし、続行してください」

    2. 共同作業/コミットを選択します。 これにより、競合しているファイルが「マージの競合」とマークされて差異があることが示されます。

      競合を解決するには、 をクリックします。

    3. マージアプリケーションが既に追加されていることを確認します。 マージアプリケーションを追加するには、前提条件の手順に従います。

    4. 次に、コミットする変更内容を選択し、マージアプリケーションに保存します。マージアプリケーションを閉じます。

    5. 既に開いているコミットダイアログボックスでファイルを選択し、コミットの説明を入力します。「コミット」をクリックします。

      次に、「プッシュ」をクリックします。 GitHub リポジトリの変更内容と RoboHelp プロジェクトが同期されます。

GitHub に追加された RoboHelp プロジェクトを開く

  1. RoboHelp プロジェクトが存在する GitHub リポジトリの正しいパスを入力していること、およびローカルで GitHub プロジェクトのクローンを作成する際の保存先とする空のフォルダーをローカルパスが指していることを確認します。

  2. RoboHelp を開きます。

  3. 共同作業/接続を開く/<プロファイル名>を選択します。 ローカルシステムでリポジトリのクローンの作成が開始されます。

  4. .rhpj ファイルをダブルクリックしてプロジェクトを開きます。

    GitHub プロジェクトが開きます。

  5. プッシュまたはプルを使用して、変更内容のコミットを開始できます。 競合を解決するには、「RoboHelp プロジェクトの GitHub への追加」の手順 9 を参照してください。

ヘルプをすばやく簡単に入手

新規ユーザーの場合