rojopolis / spellcheck-github-actions

Spell check action
MIT License
132 stars 38 forks source link

Use ::error:: messages, reported as job summary annotations #67

Closed riccardoporreca closed 2 years ago

riccardoporreca commented 2 years ago

This is a suggestion motivated by the fact that having the error message reported as an annotation in a failing job summary gives explicit indication about the reason for the failure, which can be informative for workflows with several steps prior to digging into the logs.

See Workflow commands for GitHub Actions.

You can see this in action for a dummy example repo riccardoporreca/spellcheck-github-actions-example, in particular in the "Summary" of run https://github.com/riccardoporreca/spellcheck-github-actions-example/actions/runs/1382997051 and the log of job "Spellcheck with ::error::" (which uses a little trick to test the entrypoint from the fork).