Actionable Error Messages
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
GitLab error messages should be actionable.
An actionable error message tells the user how to proceed towards their goal; hopefully without encountering another error, like a missing space helmet.
Actionable Error Messages make users less frustrated, and help push things forward.
Actionable Error Messages also make it easier to test and apply resolutions automatically.
Real stories
glab ask git
User checking out glab ask git gets non-actionable message. #409636 (comment 1434258155)
$ glab ask git how do I know the branch I am currently on
x Error: API is unreachable error=POST https://gitlab.com/api/v4/ai/llm/git_command: 401 {message: 401 Unauthorized}The actionable message is to check if the user has Ultimate subscription and say "Enable Ultimate subscription to use this feature".
skipped job
When a job is skipped, the user is not given any guidance why, and how to make it run if needed. #467575
The actionable message should provide resolutions.
depleted quota
When users hit the pages:deploy limit a message pops up:
- Namespace reached its allowed limit of 500 extra deployments
There is no additional context on what to do when this happens which can cause confusion among users.
The actionable message should
- tell why quota is depleted
- propose how to fix it