GitHubのブランチ保護でステータスチェックを必須にする

#GitHub

kato

2023.09.30

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

はじめに

GitHubには保護されたブランチという機能があり、ブランチに対してプッシュをする前に特定の条件をクリアしていることを強制することができます。例えば、1人以上の承認レビューが必要であるという条件をつけることで、レビューされていないプルリクエストが誤ってマージされるのを防ぐことができます。

どういう条件が設定できるかは、GitHub上にブランチ保護ルールとしていくつか選択肢が用意されていますが、「マージ前にステータスチェック必須」という機能を使って、指定されたCIテストにパスすることを必須にすることができるようです。どのように設定するのかなと疑問に思いましたので、この記事で実際に試してみます。

保護されたブランチについて - GitHub Docs

リポジトリ作成

GitHubのドキュメントには、

保護されたブランチは、GitHub Free及びOrganizationのGitHub Freeのパブリックリポジトリ、GitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverのパブリック及びプライベートリポジトリで利用できます。

とあります。今回はGitHub Freeのアカウントを使用するので、パブリックリポジトリを作成します。

新しいパブリックリポジトリを作成し、.gitignoreファイルだけがある状態です。

ブランチ保護の設定は、リポジトリの「Settings」⇒「Branches」から行えます。今はルールが何もないので、「Add branch protection rule」をクリックしてルールを作成します。

ステータスチェックを必須にするには「Require status checks to pass before merging」にチェックを入れます。今はまだ、チェックを入れても「No status checks found」と表示されて何も選択できません。よく読むと、過去1週間に行われたCIテストを探すようなので、まずはCIテストがリポジトリで実行される必要があります。

ワークフロー作成

リポジトリをローカルにチェックアウトして、.github/workflows/check.ymlファイルを作成します。

name: Status Check
on:
  push:
    branches:
      - '**'
      - '!master'

jobs:
  check1:
    runs-on: ubuntu-latest

    steps:
      - name: something test1
        run: exit 1

  check2:
    runs-on: ubuntu-latest

    steps:
      - name: something test2
        run: exit 0

そして、ブランチを作成してコミットとプッシュをします。すると、GitHubのActionsのところから、ワークフローが実行されたことがわかります。check1の方はexit 1にしているので失敗となります。