Docs feedback: Document build_failure_reason on webhook: job events
Doc in question: https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#job-events
I'm using Gitlab's webhook for job events, and one of the fields in the event body is build_failure_reason
. I've been running my webhook for a few months now, and the values of this field are "unknown_failure" 96.8% of the time, and "script_failure" 3.2% of the time.
It'd be useful if the documentation mentioned what these values mean, and any other possible values of this field.
It'd also be useful to know if there's any way that we can set this from within the CI so we can get more useful breakdowns of failure reasons. If there's not I can open a non-docs issue but I don't have enough understanding of what this field is/means to do that yet.
Edit: Diving into my data a bit more, I have a 96.8% build_status=success, 3.2% build_status=failure - is this the exact same data? success => unknown_failure, failure => script_failure? Either way it'd be useful to know if there's anything we can do to make this more useful!