I have built an action that checks that every commit in a PR matches a certain format. Unfortunately when it fails the default UI obscures relevant info, and users have to navigate out of the Conversation tab and into the Check tab just to see what went wrong.
Here’s my Action as it is today - you can see the path and name takes up all the UI space, and the message is hidden unless I mouseover it
It seems like it should be possible to display more information here: The Checks API supports things like
description, and other services seem to be able to make some use of them - like CI integrations, which will display sections listing what set of tests passed and failed.
I’ve spent about 2 days trying to figure this out, but I’m stumped.
Things I have tried:
- Creating a new Check Run and updating it’s status. This succeeded in the code but nothing changed in the UI
- Getting the check run ID of the action run (which is ridiculously obscured IMO) by
- Passing the
run_idas an input from the context
- Using the
run_idto list the workflows for that ID
- Parsing the
check_run_idout from the
check_run_urlfield of the only job that’s in the list
- Using that
check_run_idto make calls to the Checks API. These also succeed without error, but still nothing changes. Even when I set
conclusion: "failed"the Action run will succeed unless I also call
- Passing the
I feel like either this is some kind of limit of Actions that prevents them from taking advantage of the Checks UI, or I’m missing some really fundamental.
Any help would be greatly appreciated!