Github Actionsを指定したブランチだけで実行するための設定方法

はじめに

Github Actionsは便利ですが、全てのブランチで実行されると困る場合もあります。

今回は指定したブランチだけで実行できるような設定について書いていきます。

前に書いた記事の続きでやっていきたいと思います。

Github ActionsでJobを順番に実行する方法

ブランチ名を指定する

まずは、特にブランチ名を指定していない書き方を紹介します。

name: Test Github Actions
on: push
jobs:
  test_1:
    runs-on: ubuntu-latest
    steps:
      - name: Echo test_1
        run: echo "test_1"
  test_2:
    runs-on: ubuntu-latest
    needs: test_1
    steps:
      - name: Echo test_2
        run: echo "test_2"

この状態だと、pushがトリガーとなっています。しかし、ブランチの指定がないので、全てのブランチで実行されます。

例えば、masterブランチ、mainブランチのみで実行されるようにしたい、という時があると思います。そんな時はこんなふうに書きます。

name: Test Github Actions
on: 
  push:
    branches:
      - master
      - main
jobs:
  test_1:
    runs-on: ubuntu-latest
    steps:
      - name: Echo test_1
        run: echo "test_1"
  test_2:
    runs-on: ubuntu-latest
    needs: test_1
    steps:
      - name: Echo test_2
        run: echo "test_2"

ブランチ名の一部を指定する

特定のブランチ名ではなく、例えば最初に featureがつくブランチ名の場合に実行する、などやりたい場合はこんなふうに書けます。

name: Test Github Actions
on: 
  push:
    branches:
      - feature/*
jobs:
  test_1:
    runs-on: ubuntu-latest
    steps:
      - name: Echo test_1
        run: echo "test_1"
  test_2:
    runs-on: ubuntu-latest
    needs: test_1
    steps:
      - name: Echo test_2
        run: echo "test_2"