It is import, when a workflow is running to provide visual feedback to the user. This is where the checks and annotation API is handy as it allows you for example indicates to the user that a specific step has failed ( ❌ ) or was successfully ( ✅ ) executed; and using the API it is also possible to create a detailed annotation that points to a specific line of code; this helping the user to understand what is going on in the workflow.
The following screenshot shows the annotation API in action:
📗 In this second post, you will learn how to:
- Create custom Checks
- Add some detailed annotation with reference to source code (lines) with error
- Deploy the action
If you prefer the video version of this post go to Github Actions: Create custom Checks and Annotations .
It is time now to dive into the example!