GitHubの成果物をレビューする

概要

拡張機能の「構成管理システム連携」を使って GitHub に登録された成果物をレビュー対象に設定する方法をご紹介します。

構成管理リポジトリと接続する

レビューファイルを登録する前に、構成管理リポジトリと接続します。
具体的な操作は以下の動画と手順をご参照ください。

1. 「ツール」 - 「構成管理システムとの接続設定」メニューから、「構成管理システムとの接続設定」ダイアログを表示します。
2. 「追加」ボタンをクリックし、「構成管理リポジトリの追加」ダイアログで新しく追加したいリポジトリの情報を設定します。
   1. 次のリンクの手順でアクセストークンを取得してください。
      • GitHubのアクセストークンの取得方法
   2. 1で取得したアクセストークンを「接続情報の設定」ダイアログで設定してください。
   3. アクセス可能なリポジトリがリストで表示されます。
      対象のリポジトリを選択してください。

上記操作後、「構成管理システムとの接続設定」ダイアログに、登録した構成管理リポジトリの一覧が表示されます。

GitHubのアクセストークンの取得方法

以下の手順でアクセストークンを取得してください。

1. Git の設定ページに移動仕手ください。：「リンク」

2. 以下の項目を入力してください。

   • Name
   • Expiration （期限）
   • 「Full control of private repositories」の権限にチェック
   期限はデフォルトでは30日になっています。

   期限が切れるとアクセスできなくなりますのでご注意ください。

   

3. ページ下部の「Generate token」をクリックしてください。

   

4. 作成されたアクセストークンをコピーしてください。

   

アクセストークンは同じものを後から取得することはできないため、必要に応じて保存してください。

紛失した場合は新しいトークンを作成してください。

リポジトリからドキュメントを追加する

GitHubのリポジトリを設定して、レビュー対象のドキュメントをレビューファイルに登録します。

手順は以下をご参照ください。

1. アウトラインツリーの「リポジトリからドキュメントを追加する」アイコンをクリックします。
   • 「ファイル」タブに、登録したリポジトリのブランチのフォルダツリーが表示されます。
   • 対象成果物が格納されたフォルダを選択することで、フォルダ内のファイルやファイルごとのコミットを一覧できます。
     これにより、過去のコミットもレビュー対象に選択できます。
2. 対象成果物のコミットを選択し「OK」ボタンを押す。

上記操作により、レビューファイルのアウトラインツリーにドキュメントとして選択したファイルが登録されます。

• コミットではなくファイルを選択した場合、そのファイルのURLが関連リンクとして登録されます。

  

• Officeファイルなどアウトライン解析できるファイルは、アウトラインが作成されます。

変更前後のリビジョンの差分を確認する

ドキュメント追加時に上記の手順１で複数のリビジョンを選択することもできます。
リビジョンの差分を確認する時に便利です。

上記操作により、以下の状態になります。

• 変更前、変更後のリンクをまとめて設定する。
• 変更前のリビジョンの情報をもとにアウトラインを解析する。

既存のドキュメントにリンクを追加する

既に作成したドキュメントに対してリンクを追加することもできます。

ドキュメントだけでなく登録した指摘でも同様にリンクを設定することができます。

1. リンクを追加したいドキュメントを右クリックし、コンテキストメニューから「ドキュメントに関連リンクを追加」メニューをクリックします。
2. 「リンクの追加」ダイアログで、リポジトリアイコンのボタンをクリックし、「リポジトリから選択してリンクを設定」ダイアログを表示します。
3. 対象成果物のコミットを選択し「OK」ボタンを押します。

上記操作後、対象成果物のコミットのURLが入力されます。

レビュー対象を開く

レビューファイルに登録されたGitHubのドキュメントは、レビューファイルを開くタイミングで自動でローカルPCにダウンロードします。

アウトラインツリーに登録したドキュメントの［ジャンプ］ボタンをクリックすることで、レビューファイルを開くことができます。