GitHubインテグレーションの設定

GitHubインテグレーションのインストールや設定方法を説明します。

mabl GitHubインテグレーションをインストールする

  1. Settings > Integrations ページに移動し、GitHub カードをクリックします。
  2. GitHub Marketplaceのmabl GitHub appページでinstallをクリックし、mablをGitHubと直接インテグレーション(統合)します。
  1. インテグレーションをインストールするリポジトリを選択し、インストールをクリックします。
  2. mablのGitHubインテグレーション設定画面に転送されます。必要な設定を編集し、Saveをクリックします(何も変更しない場合は保存する必要はありません)。

📘

インストールされるワークスペースはプライマルワークスペースです。

GitHubインテグレーションは、インストールフローを完了すると、プライマリワークスペースにインストールされますので、ご注意ください。複数のワークスペースがある場合、mablアプリで現在のワークスペース名をクリックし(右上)、User Settingsをクリックして、Primary workspaceドロップダウンを設定すると、プライマリワークスペースを変更することができます。プライマリワークスペースを変更すると、統合がインストールされるワークスペースを制御できるようになります。

mabl GitHubインテグレーションをアンインストールする

mablの設定画面からmablのGitHubインテグレーションを無効にしても、GitHubから削除されません。GitHubのUIを使用してインテグレーションを削除するには、Settings > Applications の画面にアクセスする必要があります。

デプロイメントをトリガーする

GitHub ChecksやActionsを利用して、アプリがデプロイされたあとに、mablのテストを実行できます。デプロイイベントをトリガーし、mablのPlanを実行するには、以下の方法から選択できます。

🚧

PlanのTriggerにDeploymentを追加してください

デプロイイベントでPlanを実行するためには、Planの設定画面にあるTriggerに Deployment を設定してください。

curl を使って mabl のビルドを起動する

サンプルとして、curl を使用してデプロイメントイベントをトリガーする場合に、必要なペイロードの値は以下の通りです。

  • revision - git コミットハッシュ (短いまたは完全な)
  • properties.repository_url - gitリポジトリのURL (例: [email protected]/mablhq/bamboo-plugin.git)

例:

curl -s 'https://api.mabl.com/events/deployment' \
         -u 'key:MY-KEY' \
     -H 'Content-Type:application/json' \
     -d '{"environment_id":"my-env-id-e","application_id":"my-application-id-a",
     "properties":{"repository_url":"[email protected]:my-org/my-repo-name.git"},"revision":"abcd123"}'

📘

コマンドも簡単作成できます。

このようなサンプルコマンドは、 Settings -> APIs にある mabl CLIコマンドビルダーや、デプロイイベントAPIのリファレンスから簡単に作成できます。

デプロイメントが発生したとき

mablは、デプロイの一部として開始されたすべてのPlan実行を検出し、それらをGitHubインテグレーションのあるワークスペースにマッピングしようと試みます。これが成功すると、mabl GitHub Checks はコミット ID (SHA) に対して、最初は保留、次に成功または失敗として表示されます。

もしそのコミットがオープンなPull RequestのHEADコミットであれば、上記のような状態も設定されます。

mablテストのトリガーとなったデプロイメント関連のGitHubコミットが現れるかどうかをチェックmablテストのトリガーとなったデプロイメント関連のGitHubコミットが現れるかどうかをチェック

mablテストのトリガーとなったデプロイメント関連のGitHubコミットが現れるかどうかをチェック

mablでGitHubインテグレーションを管理する

Settings > Integrations ページに移動し、統合の右側にある鉛筆のアイコンをクリックして、設定を編集します。

GitHub統合の設定画面GitHub統合の設定画面

GitHub統合の設定画面

ここでできることは以下です。

GitHub integrations settings screenGitHub integrations settings screen

GitHub integrations settings screen

インサイトフィルタリング

さらに、mablが作成するIssue、またはRepository Dispatchイベントに対応するインサイト階層(通知レベルのようなもの)を指定できます。これによって、特定レベルの通知のみ送る・・・といった設定が可能です。デフォルトでは、すべてのインサイトステータスについて作成されます。カテゴリは以下のとおりです。

  • Alert(アラート)
  • Warning(警告)
  • OK
  • Improvement(改善)
  • Info(情報)

情報アイコンにカーソルを合わせると、下の画像のようにそれぞれの詳細な情報が表示されます。

最後に、GitHub Issueの作成を特定のラベルを持つプランに制限できます。頻繁に本番監視を行うプランに監視ラベルを付けている場合、その同じ監視ラベルを選択すると、mablがそれらのプランの課題のみを作成するようにできます。

ページ下部の[Save]ボタンをクリックして、行った変更を保存します。


Related resources
Did this page help you?