job summary
Markdown a step appends to the file named by GITHUB_STEP_SUMMARY, shown on the run's summary page.
In more detail
On the runner it is a real file, so a later step in the same job can read it back. It is a good place for short, human-readable results such as a deployment record.
Example
echo "started by $EVENT" >> "$GITHUB_STEP_SUMMARY"Related terms
- Markdown — A lightweight way of formatting plain text with symbols, such as # for headings and - for list items, that tools can display as formatted pages.
- default environment variables — Variables such as GITHUB_SHA, GITHUB_REF and RUNNER_OS that the runner sets for every step before your commands run.
Taught in
- Triggers and the Event Model — Continuous Integration & Continuous Delivery Pipelines
- DORA Metrics: Measuring Your Pipeline — Continuous Integration & Continuous Delivery Pipelines
- 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
- 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
- Building And Debugging A JavaScript Action — GitHub Actions (GH-200) Exam Prep