on
The top-level workflow key that lists which events start the workflow, with optional filters for each.
In more detail
It can be a single event, a list, or a mapping where each event has filters such as branches, tags and paths. Whatever wakes the workflow, the jobs are the same; the run only differs in the event it carries.
Example
on:
push:
branches: [main]
pull_request:
branches: [main]Related terms
- workflow event — Something that happens on GitHub, such as a push or a pull request, that can start a workflow run.
- event filter — Keys under an event, such as branches, tags and paths, that narrow which pushes or pull requests start a workflow.
- workflow (GitHub Actions) — A YAML file in the .github/workflows folder of a repository that names its triggers and the jobs to run.
Taught in
- What Is a Pipeline? — Continuous Integration & Continuous Delivery Pipelines
- Triggers and the Event Model — Continuous Integration & Continuous Delivery Pipelines
- The Workflow That Ran On A Stranger's Pull Request — GitHub Actions (GH-200) Exam Prep
- How GH-200 Asks: Pacing, Weights And Stems — GitHub Actions (GH-200) Exam Prep
- Triggers In Depth: Filters, Schedules And Dispatch — GitHub Actions (GH-200) Exam Prep
- Workflow Structure: Jobs, Env, Services, Commands And Anchors — GitHub Actions (GH-200) Exam Prep
- Expressions, Contexts And The If That Is Always True — GitHub Actions (GH-200) Exam Prep
- Matrices, Needs And Concurrency: The Shape Of A Run — GitHub Actions (GH-200) Exam Prep
- Reusable Workflows: Inputs, Secrets And Outputs Across A Call — GitHub Actions (GH-200) Exam Prep
- Outputs, Artifacts, Caches And Job Summaries — GitHub Actions (GH-200) Exam Prep
- Why It Ran, Why It Did Not: Reading Runs, Jobs And Checks — GitHub Actions (GH-200) Exam Prep
- Failed Runs: Debug Logging And Re-Running The Right Jobs — GitHub Actions (GH-200) Exam Prep
- Logs And Artifacts Without The Browser: REST And The gh CLI — GitHub Actions (GH-200) Exam Prep
- Workflow Templates: Sharing Workflows Across An Organization — GitHub Actions (GH-200) Exam Prep
- Three Kinds Of Action: JavaScript, Docker Container Or Composite — GitHub Actions (GH-200) Exam Prep
- action.yml: Inputs, Outputs, Runs And Branding — GitHub Actions (GH-200) Exam Prep
- Building And Debugging A JavaScript Action — GitHub Actions (GH-200) Exam Prep
- Composite And Docker Actions: Troubleshooting And Immutable Releases — GitHub Actions (GH-200) Exam Prep
- Distributing And Versioning Actions: Tags, SHAs And Marketplace — GitHub Actions (GH-200) Exam Prep
- Governing Actions: Allow Lists, SHA Pinning And Rulesets — GitHub Actions (GH-200) Exam Prep
- GitHub-Hosted And Larger Runners: Specs, Software And Networks — GitHub Actions (GH-200) Exam Prep
- Self-Hosted Runners At Scale: Labels, Groups And ARC — GitHub Actions (GH-200) Exam Prep
- Secrets And Variables By Scope: Precedence, Access And The REST API — GitHub Actions (GH-200) Exam Prep
- Usage, Billing And The Audit Log — GitHub Actions (GH-200) Exam Prep
- GITHUB_TOKEN: Least Privilege, Job By Job — GitHub Actions (GH-200) Exam Prep
- Environments: Reviewers, Wait Timers And Deployment Rules — GitHub Actions (GH-200) Exam Prep
- Script Injection: When An Issue Title Becomes Code — GitHub Actions (GH-200) Exam Prep
- OIDC: Cloud Access Without Stored Keys — GitHub Actions (GH-200) Exam Prep
- Supply Chain: Pinning, Trusted Actions And Attestations — GitHub Actions (GH-200) Exam Prep
- Faster And Cheaper: Where The Minutes Go — GitHub Actions (GH-200) Exam Prep
- YAML-Reading Sprint: What Happens When This Runs? — GitHub Actions (GH-200) Exam Prep
- Full Mock And Review: Where Your Points Go — GitHub Actions (GH-200) Exam Prep