on.pushイベントを使うと、そのリポジトリにpushした時にそのワークフローを走らせられます。on.pull_requestの場合はプルリクを上げた時だけです。
使うには以下のような一行をワークフローファイルへ置くだけです。どちらかだけを使いたいなら配列じゃなくでも良いです。
on: [push, pull_request]
# 1つだけなら `on: push` またこのon.pushやon.pull_requestは下に詳細設定を置くことがでます。
ブランチ・タグフィルター
「このブランチ、このタグがpushされた時だけ」のような設定ができます。これはブランチはbranchesまたはbranches-ignore、タグはtagsまたはtags-ignoreで設定できます。-ignoreが付いているものとそうでないものは同時に設定できません。
また一度含ませてから、一部だけ含ませないような書き方も!を頭に付けることで可能です。これは.gitignoreのような設定ファイルと同じです。
ブランチ
ブランチはデフォルトですべてのブランチが実行対象に含まれてます。例えば以下のような設定があるとします。
on:
push:
branches-ignore:
- 'features/**'
- '!features/*-master'上記の設定上ではfeatures/**にマッチしない時とfeat/*-masterにマッチする（feat/foo-masterなど）時のみワークフローが走ります。つまりこれはmasterブランチなども対象になります。
!はもちろんbranchesでも効きます。
on:
push:
branches:
- "features/**"
- "!features/*-test"タグ
タグの場合はデフォルトではすべて対象外になってます。もしすべてのタグを含めないのであれば、
on:
push:
tags:
- "*"とすることでできます。セマンティック・バージョニングな形のタグだけにしたいなら、
on:
push:
tags:
- "v[0-9].[0-9]+.[0-9]+"この場合ではfeatures/*-testにはマッチしないfeatures/**にマッチするブランチでワークフローが走ります。
ファイルフィルター
on.pushの下にはpathsとpaths-ignoreというキーも置けます。これは「コミットにパターンにマッチするファイルがあった時だけ処理するよ」またはその逆のように設定できます。
on:
push:
paths-ignore:
- '**.md'上記のような設定にしておけばすべての**.md（リポジトリ上のすべての*.mdファイル）だけのコミットの時にはワークフローを走らせずに済みます。
on:
push:
paths:
- '**.js'このようにすれば**.jsの時だけ対象にできます。
