Cheat Sheet logoCheat Sheet Today
GitHub Actions: Debugging, Logs, and Troubleshooting/Write a markdown step summary

Add a rich markdown summary to the workflow run.

Back to sheetBrowse commands
Sign in to save
Section: Debug logging and log structure

Write a markdown step summary

bash
bash
echo "## Test Summary" >> "$GITHUB_STEP_SUMMARY"
Explanation

Step summaries are excellent for concise results, links, and deployment info.

View in sheet →

Learn the surrounding workflow

Compare similar commands or jump into common fixes when this command is part of a bigger troubleshooting path.

Compare commandsView fixes

Related commands

Same sheet · prioritizing Debug logging and log structure
Create a collapsible log group
Group related output in the Actions log.
OpenIn sheetbashsame section
Emit a notice annotation
Add an informational annotation to the run log.
OpenIn sheetbashsame section
Emit a warning annotation
Highlight a non-fatal issue in the run log.
OpenIn sheetbashsame section
Emit an error annotation
Mark a step error with file context.
OpenIn sheetbashsame section
Use strict Bash mode
Fail fast in shell scripts.
OpenIn sheetbash
Inspect the raw event payload
Dump the event JSON file path or contents for debugging.
OpenIn sheetbash