› システム › システム設定 › GitHub › GitHub の統合

GitHub の統合

GitHub の統合を構成するには、次の手順を実行します。

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

  2. GitHub アプリの作成

    OAuth 専用アプリとパーソナル アクセス トークンは、更新トークンをサポートしていないため機能しません。

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

  4. TotalAgility で現在のユーザーの GitHub 統合を構成します。

GitHub アプリの作成

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

TotalAgility は GitHub の OAuth 専用アプリをサポートしていません。これは、TotalAgility で OAuth サーバーを構成するときに TotalAgility に必須である、ユーザーとして認証するための更新トークンを OAuth アプリでは生成できないためです。
  1. GitHub にサインアップします。
  2. GitHub ページで、[Create Repository] (リポジトリの作成) をクリックします。

    リポジトリには、バージョン履歴を含むすべてのプロジェクト ファイルが保持されます。

  3. リポジトリの [Repository name] (リポジトリ名) と [Description] (説明) を入力します。
  4. リポジトリにアクセスしてこのリポジトリに変更をコミットできるユーザーを制限するには、[Public] (パブリック) または [Private] (プライベート) を選択します。
  5. [Create repository] をクリックします。

    ユーザー名とリポジトリ名が表示されたコード ページが開きます。

  6. ボックスに表示されている次の GitHub URL をコピーします: https://github.com/[GitHub ユーザー名]/[リポジトリ名]。

    TotalAgility で OAuth サーバーを構成する場合に、この URL を使用します。

  7. GitHub Apps を作成するには、ページの右上隅にあるユーザー アカウント設定をクリックしてから、[Settings] (設定) をクリックします。
  8. [Account settings] (アカウント設定) で、[Developer settings] (開発者設定) をクリックします。
  9. [Developer settings] ページで、[New GitHub App] (新しい GitHub アプリ) をクリックします。

    [Register new GitHub App] (新しい GitHub アプリの登録) ページが開きます。

  10. [GitHub App name] (GitHub アプリ名) ボックスに、アプリの名前を入力します。
  11. [Homepage URL] (ホームページの URL) として「https://www.red-gate.com/simple-talk/」と入力します。
  12. [Callback] (コールバック) URL を「http://localhost」と設定します。
  13. 現在のトークンの有効期限が切れたときに更新されたトークンを要求するために使用可能な更新トークンを取得するには、[Expire user authorization tokens] (ユーザー認証トークンの有効期限) のチェック ボックスをオンのままにします。
  14. GitHub Apps のインストール ユーザーを識別して承認するには、[Request user authorization (OAuth) during installation] (インストール中にユーザー承認をリクエストする) チェック ボックスをオンにします。
  15. [Webhook URL] は、会社名または https://www.google.com などのランダムな URL に設定できます。
  16. デフォルトでは、GitHub Apps には権限がありません。GitHub Apps を作成するときに、エンドユーザー データにアクセスするために必要な権限を選択できます。また、権限は追加および削除することもできます。必要に応じて、次のグループの各アクセス許可タイプに対して、読み取り専用、アクセスなし、または読み取りと書き込みの権限を付与します。[Repository permissions] (リポジトリ権限)、[Organization permissions] (組織限)、および[User permissions] (ユーザー権限)。
  17. GitHub アプリをインストールする場所を選択します。

    • [Only this account] (このアカウントのみ) (デフォルト): 現在のユーザー アカウントによる GitHub Apps のインストールを許可します。

    • [Any account] (任意のアカウント): 任意のユーザーまたは組織による GitHub Apps のインストールを許可します。

  18. [Create GitHub App] (GitHub Apps の作成) をクリックします。

    GitHub Apps が作成されます。[General] (全般) タブには、次の詳細が表示されます。

    • [Owned by] (所有者): <GitHub ユーザー名>

    • [App ID] (アプリ ID): 143993 といった ID が表示されます。

    • [Client ID] (クライアント ID): Iv1.ff4abd15364d7d07 といった ID が表示されます。

      このクライアント ID は、TotalAgility で OAuth サーバーを構成するときに使用します。

  19. ボックスから [Public link] (パブリック リンク) の URL をコピーし、URL を保存します。
  20. API へのアプリケーションとして認証するクライアント シークレットを生成するには、[Generate a new client secret] (新しいクライアント シークレットの生成) をクリックします。

    クライアント シークレットが生成されます。たとえば、1ecd8837dc9dc3927321c8058f60bc3ab6c65f47

    クライアント シークレットを再度表示することはできないため、シークレットをコピーして保存してください。必要に応じて、新しいシークレットを生成できます。このクライアント シークレットは、TotalAgility で OAuth サーバーを構成するときに使用します。
  21. [Save changes] (変更の保存) をクリックします。
  22. [Settings] > [Developer settings] > [GitHub Apps] に移動します。

    <GitHub ユーザー名> ページが開きます。

  23. [Install App] (アプリのインストール) をクリックします。

    GitHub アプリがリポジトリにインストールされます。

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

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

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

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

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

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

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

    11. ブラウザのタブから URL をコピーし、[新しい OAuth 2.0 サーバー構成] ダイアログ ボックスの [認証コード] ボックスに貼り付けて、[承認する] をクリックします。
    12. デフォルトでは、[更新トークンをサポート] チェック ボックスが選択されており、読み取り専用です。つまり、GitHub と通信するたびに OAuth 更新トークンが必要です。
    13. [保存] をクリックします。

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

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

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

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

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

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

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

  6. GitHub 接続をテストするには、GitHub カードで [リポジトリ] をクリックします。

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

  7. [接続のテスト] をクリックします。

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

  8. [承認する] ダイアログ ボックスで、次のいずれかの操作を実行します。

    • [認証コードの取得] リンクをクリックします。

      認証サーバーは、認証サーバーの構成に使用されたカスタム リダイレクト URI にリダイレクトします。認証サーバーによるリダイレクト先の URL 全体をコピーし、[認証コード] フィールドに貼り付けます。[承認する] をクリックして、リソースの GitHub アクセスを承認します。接続を確立するために、認証サーバーから有効な更新トークンが取得されたことを確認し、[保存] をクリックします。

      接続の詳細が保存されます。

    • GitHub 機能なしで続行するには、[キャンセル] をクリックします。

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

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

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