Define the type of activity that will trigger a workflow run.
Most GitHub events are triggered by more than one type of activity.
For example, the label is triggered when a label is created, edited, or deleted.
The types keyword enables you to narrow down activity that causes the workflow to run.
When only one activity type triggers a webhook event, the types keyword is unnecessary.
Use the branches filter when you want to include branch name patterns or when you want to both include and
exclude branch names patterns.
Accepts glob patterns that use characters like *, **, +, ?, ! and others to match more than one branch
or tag name.
If a name contains any of these characters and you want a literal match, you need to escape each of these special
characters with \.
Use the branches-ignore filter when you only want to exclude branch name patterns.
You cannot use both the branches and branches-ignore filters for the same event in a workflow.
Accepts glob patterns that use characters like *, **, +, ?, ! and others to match more than one branch
or tag name.
If a name contains any of these characters and you want a literal match, you need to escape each of these special
characters with \.
Use the tags filter when you want to include tag name patterns or when you want to both include and exclude tag
names patterns.
Accepts glob patterns that use characters like *, **, +, ?, ! and others to match more than one branch
or tag name.
If a name contains any of these characters and you want a literal match, you need to escape each of these special
characters with \.
Use the tags-ignore filter when you only want to exclude tag name patterns.
You cannot use both the tags and tags-ignore filters for the same event in a workflow.
Accepts glob patterns that use characters like *, **, +, ?, ! and others to match more than one branch
or tag name.
If a name contains any of these characters and you want a literal match, you need to escape each of these special
characters with \.
Use the paths filter when you want to include file path patterns or when you want to both include and exclude file
path patterns.
Accepts glob patterns that use the * and ** wildcard characters to match more than one path name.
For more information, see the
Workflow syntax for GitHub Actions.
Use the paths-ignore filter when you only want to exclude file path patterns.
You cannot use both the paths and paths-ignore filters for the same event in a workflow.
If you want to both include and exclude path patterns for a single event, use the paths filter prefixed with the
! character to indicate which paths should be excluded.
Accepts glob patterns that use the * and ** wildcard characters to match more than one path name.
For more information, see the
Workflow syntax for GitHub Actions.
Define the type of activity that will trigger a workflow run.