リポジトリの準備

保護ブランチの設定は、既存のリポジトリに適用するとこれまでの操作と混ざってしまい分かりづらくなります。このセクションでは、専用の新しいリポジトリを作成し、そこに最小限のファイルだけを配置した状態で進めます。

1. GitHubでの空リポジトリの作成

GitHubにログインし、右上の**+ボタンからNew repository**をクリックします。

以下の設定でリポジトリを作成します。

設定項目 値 設定の基準
Owner ご自身のGitHubアカウント 自分のアカウントで管理するため
Repository name devopscamp-branch-protection-handson ハンズオン用のリポジトリ名
Visibility Public GitHub Actionsの無料実行時間を気にせず使えるため
Initialize this repository with 何もチェックしない 後から自分でファイルをPushするため

Create repositoryをクリックしてリポジトリを作成します。

作成後、「Quick setup」の画面が表示されたら、ここでは何も操作せずに次のステップに進みます。

GitHubのリポジトリ一覧にdevopscamp-branch-protection-handsonが表示されていれば、ここまでの操作は完了です。

2. リポジトリのClone

作成したリポジトリをローカル環境にcloneします。ローカル環境で、Windowsであればコマンドプロンプト、Macであればターミナルを開きます。

以下のコマンドで、Git がインストールされていることを確認します。

git --version

以下のように Git のバージョンが表示されれば、インストールは確認できています。

git version 2.x.x

バージョンが表示されない場合は、Git/GitHubのセットアップ を先に実施してください。

インストールが確認できたら、下記のコマンドを実行します。<your-github-account-name>の部分はご自身のGitHubアカウント名に置き換えてください。

git clone https://github.com/<your-github-account-name>/devopscamp-branch-protection-handson.git

空のリポジトリなのでYou appear to have cloned an empty repository.という警告が表示されますが、問題ありません。

3. サンプルファイルの作成

Visual Studio Codeでdevopscamp-branch-protection-handsonフォルダを開きます。「ファイル」メニュー >「フォルダを開く」から、先ほどcloneしたフォルダを選択してください。

このセクションでは、保護ルールが動作することを確認するために2つのファイルを用意します。1つ目はREADME.md、2つ目はPRの際にREADME.mdの存在をチェックするワークフローファイルです。静的解析や自動テストのような本格的な内容は不要で、「単にREADME.mdがあるかどうか」というごく単純なチェックで保護ルールの動作を確認します。

まず、リポジトリ直下にREADME.mdを作成します。

devopscamp-branch-protection-handson/
└── README.md  ← このファイルを作成

作成したファイルに以下の内容を記述して保存します。

# devopscamp-branch-protection-handson

DevOps Campの保護ブランチハンズオン用リポジトリです。

次に、ワークフローファイルを作成します。.github/workflows/check-readme.ymlを作成します。

devopscamp-branch-protection-handson/
├── README.md
└── .github/
    └── workflows/
        └── check-readme.yml  ← このファイルを作成

作成したファイルに以下の内容を記述して保存します。

name: README Check

on:
  pull_request:
    branches:
      - main

jobs:
  check-readme:
    name: Check README exists
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v5

      - name: Check README.md exists
        run: |
          if [ ! -f README.md ]; then
            echo "Error: README.md does not exist"
            exit 1
          fi
          echo "README.md exists"

このワークフローは、Pull Requestが作成された際に動き、リポジトリ直下にREADME.mdがあれば成功、なければ失敗するという非常にシンプルなチェックを行います。本章ではこのワークフローを「必須ステータスチェック」として利用します。

4. 初回コミットとPush

ローカルリポジトリに2つのファイルを配置できたので、GitHubにPushしてリモートリポジトリに反映させます。

Visual Studio Codeのターミナルを開き、以下のコマンドを1つずつ実行します。

ステージングします。

git add .

コミットします。

git commit -m "initial commit"

mainブランチにPushします。

git push origin main

GitHubのリポジトリページを更新すると、README.mdと.github/workflows/check-readme.ymlが表示されます。これが表示されていれば、ここまでの操作は完了です。