feat: add summary to action job #62
Conversation
| .addList( | ||
| errors.map( | ||
| (error) => | ||
| `🔴 Line ${error.line}: ${error.ruleId} - ${error.description}` | ||
| ) | ||
| ) |
There was a problem hiding this comment.
I wonder if you could consider eslint stylish formatter style here? I guess this format will be more familiar to the community.
If it's not very late, I'd also use the the same format in action logs
There was a problem hiding this comment.
I can ask the team and see what their thoughts were on this. I don't see why this would be an issue
| // Create GitHub annotations | ||
| for (const error of errors) { | ||
| core.error( | ||
| `${file}:${error.line} - ${error.ruleId} - ${error.description}`, |
There was a problem hiding this comment.
file:line looks redundant here, GH annotation will display this info anyway since you provide it in the options
There was a problem hiding this comment.
So this is defined in both GH annotations but also in the workflow itself. Without the file and line number the error is not too helpful
Ref: #60
There was a problem hiding this comment.
If you output errors in eslint stylish format, you don't need to manually create annotations, you can rely on GH Problem Matchers:
=>
- readable errors in workflow logs
- annotations without redundancy
This PR adds a summary to the job
ex:
qa notes: make sure that a summary exist similar to the screenshot above when errors are found