Skip to content

Add placeholder for better missing-SVG error message

Amy Qualls requested to merge 1777-aqualls-update-error-message into main

What does this MR do and why?

gitlab!147384 (merged) had a failing pipeline because the author tried to use an SVG that existed in a newer release of https://gitlab.com/gitlab-org/gitlab-svgs than was included in the current html-lint Docker image.

https://gitlab.com/gitlab-org/gitlab/-/jobs/6494463042 is the pipeline that failed. The bottom of the failed pipeline looks like this:

bottom

The real error is back further up, and doesn't have much helpful information or any color-coding:

real

I've opened this MR to ask more Ruby-proficient people what we can do to make the message in lib/helpers/icons_helper.rb better:

  • Improve the text?
  • Add color-coding?
  • Anything else I haven't thought of?

Related items

Screenshots, screen recordings, or links to review app

These are strongly recommended to assist reviewers and reduce the time to merge your change.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md.

Merge request acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports