› システム › 追加設定 › GitHub › リポジトリ › GitHub 統合の構成

GitHub 統合の構成

GitHub に接続するようにマシンを構成できます。

GitHub 統合は、TotalAgility Apps 内ではサポートされていません。

前提条件

GitHub 統合を構成するための前提条件は次のとおりです。

  1. GitHub にサインアップします。

  2. GitHub アプリの作成

GitHub アプリの作成

GitHub アプリを作成し、OAuth トークンを生成および使用してユーザーを識別します。OAuth アクセス トークンは、GitHub アプリのユーザーとして認証できます (ユーザー/サーバー間リクエストとも呼ばれます)。たとえば、GitHub アプリがユーザーの ID を確認したり、ユーザーに代わって動作を行ったりする必要がある場合は、OAuth アクセス トークンを使用してユーザーとして認証できます。

TotalAgility は GitHub の OAuth アプリをサポートしていません。これは、TotalAgility で OAuth サーバーを構成するときに必須である、ユーザーとして認証するための更新トークンを OAuth アプリでは生成できないためです。

同じことがパーソナル アクセス トークンにも当てはまります。また、更新トークンもサポートしていません。

デフォルトでは、GitHub アプリにはエンドユーザー データにアクセスする権限がありません。GitHub アプリを作成するときに、必要な権限を追加する必要があります。次のグループの下で、タイプごとに読み取り権限と書き込み権限を付与できます。読み取りと書き込みの権限を付与します。

以下は、GitHub 統合がリポジトリにアクセスするために必要な最小限のリポジトリ権限です。

アクセス許可

アクセス タイプ

コンテンツ: リポジトリのコンテンツ、コミット、分岐、ダウンロード、リリース、および結合。

読み取りと書き込み

プル リクエスト: プル リクエストと関連するコメント、担当者、ラベル、通過ポイント、および結合。

読み取りと書き込み

コミット ステータス: コミットのステータス

読み取りと書き込み

TotalAgility での現在のユーザーの GitHub 統合の構成

GitHub Apps が作成された後に、マシンを、TotalAgility ソリューションを保持しているか保持する予定の GitHub サーバーに接続するように構成できます。

GitHub アプリのクライアント ID とクライアント シークレットを使用して TotalAgility で OAuth サーバーを構成してから、認証コードを取得して、自分の GitHub アクセスを承認する必要があります。

TotalAgility 用の OAuth サーバーの構成

GitHub Apps の作成時に生成された GitHub URL、アクセス トークン URL、クライアント ID、およびクライアント シークレットを使用して OAuth サーバーを構成します。

GitHub アプリのクライアント ID とクライアント シークレットを使用して TotalAgility で OAuth サーバーを構成してから、認証コードを取得して、自分の GitHub アクセスを承認する必要があります。

  1. [統合] > [OAuth サーバー] に移動し、[新規] をクリックします。
  2. OAuth サーバーの一意の [名前] を入力します。
  3. デフォルトでは、システムによって新しい OAuth サーバーが作業カテゴリに自動的に保存されます。別のカテゴリに保存するには、カテゴリを選択します。
  4. [認証コード] として [付与タイプ] を選択します。
  5. [認証方法] を選択します。
  6. [クライアント ID] と [クライアント シークレット] を入力します。
  7. アクセス トークンを取得するには、[アクセス トークン URL] として「https://github.com/login/oauth/access_token」と入力します。
  8. [認証コード URL] として「https://github.com/login/oauth/authorize」と入力します。
  9. [カスタム リダイレクト URI を使用する] を選択し、ボックスに http://[TotalAgility サーバー]/TotalAgility/Designer/OAuth2_Authorization.html というリダイレクト URI を入力します。

    TotalAgility のカスタム リダイレクト URI は、GitHub で構成されたコールバック URL と一致している必要があります。「リダイレクト URI」と「カスタム リダイレクト URI を使用する」の詳細については、「認証コード付与タイプを使用した OAuth サーバーの構成」を参照してください。

  10. デフォルトでは、[更新トークンをサポート] チェック ボックスが選択されており、読み取り専用です。つまり、GitHub と通信するたびに OAuth 更新トークンが必要です。
  11. [承認する] をクリックします。

    GitHub にサインインするように求めるメッセージが表示されます。

  12. ユーザー名または電子メール アドレスおよびパスワードを使用して、GitHub にサインインします。

    承認されたアプリケーションにリダイレクトされます。

  13. ブラウザのタブから URL をコピーし、[新しい OAuth サーバー構成] ダイアログ ボックスの [認証コード] ボックスに貼り付けて、[承認する] をクリックします。
  14. [保存] をクリックします。

    OAuth サーバーが構成されます。

GitHub リポジトリの指定とアクセスの承認

  1. [システム] > [追加設定] > [GitHub] に移動し、[リポジトリ] をクリックします。

    [GitHub リポジトリ] ダイアログ ボックスが表示されます。

  2. GitHub リポジトリの [URL] を入力します。
  3. この項目は任意です。GitHub リポジトリの [分岐] を指定します。分岐を指定しないと、デフォルトの分岐が複製されます。

    GitHub リポジトリはアプリ サーバーに複製されます。現在、Windows では 260 文字を超えるパスは許可されていません。

  4. [OAuth サーバー] リストで、GitHub サーバー用に事前構成された OAuth サーバーを選択し、[保存] をクリックします。

    現在のユーザーの GitHub と通信するには、OAuth トークンが必要です。OAuth サーバーの詳細を変更すると、アクセス トークンがクリアされます。アクセス トークンを再承認する必要があります。

  5. GitHub 接続をテストするには、[接続のテスト] をクリックします。

    [承認する] ダイアログ ボックスが表示されます。GitHub アクセス用に構成されたリソースとして TotalAgility Designer にログオンする場合、OAuth サーバーの構成時に「カスタム リダイレクト URI」を指定する場合は、GitHub アクセス用に自分を承認するか、GitHub 機能なしで続行するように求めるメッセージが表示されます。

    自分自身に GitHub へのアクセスを許可するには、次の手順を実行します。

    1. [認証コードの取得] リンクをクリックします。認証サーバーは、認証サーバーの構成に使用されたカスタム リダイレクト URI にリダイレクトします。

    2. 認証サーバーによるリダイレクト先の URL 全体をコピーし、[認証コード] フィールドに貼り付けます。

    3. [承認する] をクリックします。

    4. 接続を確立するために、認証サーバーから有効な更新トークンが取得されたことを確認し、[保存] をクリックします。

    GitHub 機能を使用せずに続行するには、[キャンセル] をクリックします。

    追加のユーザーが TotalAgility Designer を起動すると、ログオン時に自分の GitHub アクセスを承認するように求められます。

  6. GitHub のソース管理への接続を削除するには、[承認する] ダイアログ ボックスの [削除] をクリックします。

    確認すると、接続が削除されます。