1. Homepage
  2. Design Center
  3. API Designer
  4. GitHub Synchronization

  5. GitHub Synchronization のインストールと認証

GitHub Synchronization のインストールと認証

API Designer から組織のリポジトリにアクセスできるようにするための第一歩は、GitHub Synchronization アプリケーションをインストールすることです。

GitHub Synchronization アプリケーションは、GitHub ユーザーインターフェースでインストールします。このアクションは、GitHub 組織のシステム管理者または GitHub ユーザーとして実行します。その後、API Designer 内で最初に GitHub Synchronization アクションを実行するときに、アプリケーションを認証します。同期アクションとしては、既存 API 仕様にと同期させる新規 GitHub リポジトリの作成や、既存の GitHub リポジトリと同期させる新規 API 仕様の作成などがあります。

GitHub 組織のシステム管理者としての GitHub Synchronization アプリケーションのインストール

まず、GitHub Synchronization アプリケーションは、GitHub ユーザーインターフェースでインストールします。

始める前に

GitHub 組織のシステム管理者として GitHub Synchronization アプリケーションをインストールするには、次の要件を満たす必要があります。

  • GitHub アカウント

  • アプリケーションをインストールする GitHub 組織のメンバーシップ

  • GitHub 組織にアクセスするための (GitHub アカウント設定で付与された) 管理者権限

  • GitHub アカウントで IP 許可リストを使用している場合は、GitHub Synchronization をインストールして使用することはできません。

  • GitHub Synchronization で使用する GitHub アカウントのメール設定で ​[Keep my email addresses private (メールアドレスを非公開にする)]​ を選択した場合は、​[Block command line pushes that expose my email (メールを公開するコマンドラインプッシュをブロック)]​ を選択しないでください。ブロック設定により、同期プロジェクトでのコミットがプッシュされなくなります。

GitHub Synchronization アプリケーションをインストールする

  1. GitHub Synchronization アプリケーションページ​に移動します。

  2. [Install (インストール)]​ をクリックします。

  3. [Install MuleSoft GitHub Integration (MuleSoft GitHub インテグレーションをインストール)]​ ダイアログで、アプリケーションをインストールする組織を選択します。

  4. [All repositories (すべてのリポジトリ)]​ をクリックして、すべてのリポジトリを使用できるようにするか、または ​[Only select repositories (選択したリポジトリのみ)]​ をクリックして個別のリポジトリを指定します。

  5. [Install (インストール)]​ をクリックします。

GitHub とのインテグレーションを完了するには、アプリケーションを API Designer で認証する必要があります。​「API Designer で GitHub Synchronization アプリケーションを認証する」​を参照してください。

GitHub ユーザーとしての GitHub Synchronization アプリケーションのインストール

GitHub ユーザーアカウントで GitHub Synchronization アプリケーションをインストールすることで、自分の GitHub ユーザーリポジトリとの同期が可能になります。

始める前に

GitHub ユーザーとして GitHub Synchronization アプリケーションをインストールするには、次の要件を満たす必要があります。

  • GitHub アカウント

  • アプリケーションをインストールする GitHub 組織のメンバーシップ

GitHub Synchronization で使用する GitHub アカウントのメール設定で ​[Keep my email addresses private (メールアドレスを非公開にする)]​ を選択した場合は、​[Block command line pushes that expose my email (メールを公開するコマンドラインプッシュをブロック)]​ を選択しないでください。ブロック設定により、同期プロジェクトでのコミットがプッシュされなくなります。

GitHub Synchronization アプリケーションをインストールする

  1. GitHub Synchronization アプリケーションページ​に移動します。

  2. [Install (インストール)]​ をクリックします。

  3. [Install MuleSoft GitHub Integration (MuleSoft GitHub インテグレーションをインストール)]​ ダイアログで、GitHub ユーザーアカウント (通常は表示されたリストの上の方に表示されます) を選択します。

  4. [All repositories (すべてのリポジトリ)]​ をクリックして、すべてのリポジトリを使用できるようにするか、または ​[Only select repositories (選択したリポジトリのみ)]​ をクリックして個別のリポジトリを指定します。

  5. [Install (インストール)]​ をクリックします。

GitHub とのインテグレーションを完了するには、アプリケーションを API Designer で認証する必要があります。​「API Designer で GitHub Synchronization アプリケーションを認証する」​を参照してください。

API Designer で GitHub Synchronization アプリケーションを認証する

GitHub Synchronization アプリケーションを認証するには、自分のユーザー ID に「Design Center Developer (Design Center 開発者)」権限が付与されている必要があります。

  1. Anypoint Platform にサインインします。

  2. Design Center の ​[Projects (プロジェクト)]​ ページで、​[Create + (作成 +)]​ をクリックします。

  3. [New API Specification (新しい API 仕様)]​ を選択します。

  4. [New API Specification (新規 API 仕様)]​ パネルで、​[Authorize the MuleSoft app now to get started (これから開始する MuleSoft アプリケーションを認証する)]​ をクリックします。

  5. [Authorize (認証)]​ をクリックします。

  6. 次に表示されるダイアログで、​[Authorize MuleSoft GitHub Integration (MuleSoft GitHub インテグレーションを認証)]​ をクリックします。

API Designer にリダイレクトされ、​「Authorized Successfully (正常に認証されました)」​のメッセージが表示されます。これで、このアプリケーションの認証をトリガーしたプロセスを完了できるようになります。

GitHub Synchronization アプリケーションのインストールのトラブルシューティング

GitHub Synchronization アプリケーションの認証中にエラーが発生した場合は、認証を取り消してから、認証を再び試みてください。

  1. GitHub ユーザーインターフェースで (​[Settings (設定)]​ > ​[Applications (アプリケーション)]​ > ​[Authorized GitHub Apps (認証済み GitHub アプリケーション)]​ に移動して) ​[Revoke (取り消し)]​ をクリックします。

  2. GitHub Synchronization アプリケーションを認証します​。

空のリストが表示された場合は、同期アクションを実行する前に、アプリケーションを GitHub 組織または GitHub ユーザーアカウントにインストールしてあることを確認してください。

GitHub インテグレーションの無効化

組織のシステム管理者は、Github インテグレーションを無効化できます。

  1. Design Center の ​[Projects (プロジェクト)]​ ページで、​[Settings (設定)]​ をクリックします。

  2. [Integrations (インテグレーション)]​ で、​[Enable Github Integration (GitHub インテグレーションを有効化)]​ をオフにします。

  3. 確認ダイアログボックスが表示されます。

  4. [Disable GitHub (GitHub を無効化)]​ をクリックします。

これで、インテグレーションが無効になります。 組織にサブ組織がある場合、組織のシステム管理者は必要に応じてサブ組織ごとにインテグレーションを有効または無効にできます。

このアクションにより、組織のすべてのユーザーとプロジェクトのソースの同期が無効になります。インテグレーションが有効になると、GitHub にまだリポジトリが存在していても、過去のすべての同期が失われます。