datamade / how-to

📚 Doing all sorts of things, the DataMade way
MIT License
80 stars 12 forks source link

Improve Github Action logging #359

Open smcalilly opened 5 months ago

smcalilly commented 5 months ago

Description

Sometimes a GitHub action build will fail and the problematic error message is buried deep in the action logs. This makes it harder to find the cause of the build failure, unless you've been burned by this before and know to comb through each line in the log.

We need to research GitHub action logging to see if there's a setting or best practice to elevate these error messages.

For example, this build failure prompted me to open this issue. In the action logs, search E722 do not use bare 'except'. It isn't obvious that this error caused the action to fail — that line is buried in the logs, one would expect it to be red and bold and maybe even the last line in the logs, or at least have the last line in the logs tell us about this error instead of giving the generic 1 failure code.