event payload
The full description of the event that started a run, stored as a JSON file on the runner whose path is in GITHUB_EVENT_PATH.
In more detail
It holds details the environment variables do not, such as which pull request action fired, the pull request number, the base branch and whether the head branch lives in a fork. Tools such as jq read it; the github context is a summary of it.
Example
jq -r '.pull_request.head.repo.fork' "$GITHUB_EVENT_PATH"Related terms
- github context — The expression object that describes the current run: its event, commit SHA, ref, actor, repository and more.
- JSON — A simple text format for structured data made of keys, values, lists and nested objects.
- jq — A command-line tool that reads, filters and reshapes JSON data.
Taught in
- Triggers and the Event Model — Continuous Integration & Continuous Delivery Pipelines