Improving action ergonomics

[marcransome]

Action ergonomics

Currently all custom GitHub actions provided by fish-shop report their results as part of the job output in a workflow. Whilst some care has been taken to ensure that this output is clear and human-readable, having to navigate away from a pull request to view these results can be inconvenient.

An alternative approach might involve the use of checks and line annotations. Being able to view results directly alongside the code that it relates to can be more convenient.

Examples

The following images show examples of the difference in approach for the fish-shop/syntax-check action:

Workflow job output

All results are reported in the job output within a workflow (the current action behaviour):

Checks with line annotations

Results are reported in a more contextual manner alongside the affected lines in a pull request:

Tip

To see more, take a look at this example pull request.

Poll

[marcransome]

Annotations have been added to the fish-shop/syntax-check action in release v2.2.0 while maintaining the previous workflow job output. 🎉