Skip to content

Notify users about unavailable linter in the linter widget

Frédéric Caplette requested to merge 346038-notify-users-about-unavailable-linter-in-the-linter-widget-instead-of-a-500-error-alert into master

What does this MR do and why?

In pipeline editor, when the Linter API returns an error, we cannot validate CI configurations, show the visualization or the merged YAML. So we now have an improved experience that handles that state. This means:

  • The validation widget has a special state for when it cannot give an answer to: Is this valid?
  • All tabs except the edit one will have a generic error message

Screenshots or screen recordings

Before After
Screen_Recording_2021-12-16_at_5.30.04_PM Screen_Recording_2021-12-16_at_2.08.28_PM

How to set up and validate locally

  1. Go to CI/CD => Editor
  2. Since you cannot trigger a 500 error in the UX (which is a good thing!) you can comment out one of the variables in the ciConfigData query Screen_Shot_2021-12-16_at_5.10.00_PM
  3. Refresh the page
  4. Notice how the validation segment (the linter widget) now shows a new error message
  5. Check each tab and ensure the messages are accurate

MR acceptance checklist

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

Related to #346038 (closed)

Edited by Frédéric Caplette

Merge request reports