Bitrise Checks は、Bitrise が GitHub に送り返すステータスチェックを拡張する Github アプリです。 Bitrise Checks には、 Bitrise のビルドサマリーとチェックステータスが含まれています。 GitHub 上のプルリクエストの Details リンクをクリックすると、 Bitrise Checks を見ることができます。これは、 Bitrise Checks がプルリクエストに添付した詳細なビルドサマリーとビルドステータスを GitHub の Checks タブに展開します。
チェックの状態は3種類あります。
- Success
- Failed
- Action required (手動でプルリクエストを承認する場合)
Bitrise Checks のインストール ⚓
Bitrise Checks は数クリックで利用できます。さあ、やってみましょう。
- Dashboard であなたの組織のアプリを選択します。
- アプリの Settings タブを選択します。
-
ENABLE GITHUB CHECKS の説明にある install our app to your GitHub repository リンクをクリックします。 Bitrise Checks をインストールする必要があるので、まだスイッチを有効化しないでください。 有効化については 後ほど 説明します。
このリンクをクリックすると GitHub の Bitrise Checks インストールページに移動します。
-
Install Bitrise Checks ページで、Bitrise Checks を追加するユーザーまたは組織を選択します。
-
Bitrise Checks をすべてのリポジトリにインストールするか、一部のリポジトリにのみインストールするかを選択します。これにより、Bitrise Checks があなたのリポジトリに統合され、 GitHub Checks を使用してチェック結果を表示する権限が付与されます。
- GitHub のプロンプトで、 GitHub のパスワードを入力します。
うまくいけば、GitHub の Bitrise Checks ページが表示されます。ページの上部に、Bitrise Checks が GitHub アカウントに正常にインストールされたことを示す青いメモが表示されているはずです。
GitHub Checksの有効化 ⚓
あとは Bitrise のアプリのページで GitHub Checks を有効化するだけです。
- あなたの組織の Dashboard に移動します。
- Bitrise Checks をインストールした GitHub リポジトリのアプリをクリックします。
- アプリの Settings タブを選択します。
- ENABLE GITHUB CHECKS のスイッチを切り替え有効化します。
ENABLE GITHUB CHECKS のスイッチが切り替えられない場合、
- 先に Bitrise Checks をインストールしないとスイッチを切り替えることはできません。
-
すでに Bitrise に追加されているアプリの GitHub リポジトリの名前を変更または移動し、そのアプリに Bitrise Checks をインストールした場合はスイッチが機能しません。Github 上のURLと Bitrise 上のURLが完全に一致している場合にのみ、ENABLE GITHUB CHECKS スイッチが機能します(リダイレクトURLは許可されていません)。その場合は、Settings タブの REPOSITORY URL を 新しい GitHub URL に手動で更新する必要があります。
これで完了です。GitHub 上でアプリに送ったプルリクエストは Bitrise Checks で検証され、Bitrise 上でビルドが自動的に開始されます(Bitrise 上でプルリクエストのトリガーが適切に設定されている必要があります)。
Bitrise では、アプリのページに簡単にアクセスできます。ビルドサマリーをクリックするか、Checks タブの Bitrise Checks リンクをクリックすると、アプリのビルドページにすぐにアクセスできます。
Bitrise Checks への切り替え ⚓
マージ前のプルリクエストですでにステータスチェックを使用していた場合は、それが ci/bitrise/...
チェックシステムであったはずです。Bitrise Checks を使用するには、手動で ci/bitrise/...
から Bitrise に切り替える必要があります。では、その方法を見てみましょう。
- あなたのリポジトリの Settings タブに移動します。
-
サイドメニューの Branches を選択します。 Require status checks to pass before merging の下を見ると
ci/bitrise/...
が選択されています。 ci/bitrise/...
の代わりに Bitrise を選択します。- プルリクエストをマージします。
GitHub Checks の無効化 ⚓
アプリの Settings ページで ENABLE GITHUB CHECKS スイッチを左に切り替えれば、Bitrise の GitHub Checks を簡単に無効にすることができます。
GitHub アカウントから Bitrise Checks をアンインストールする場合は、Install GitHub Apps ページの Uninstall ボタンをクリックしてください。