Skip to content

Add links to code quality descriptions from Vale checks

Anatoli Babenia requested to merge gitlab-community/gitlab:vale-links into master
  • Please check this box if this contribution uses AI-generated content (including content generated by GitLab Duo features) as outlined in the GitLab DCO & CLA

What does this MR do and why?

It is not obvious how to fix the certain Vale problem, because links with more information from Vale rules are not exposed. See !156571 (comment 1954147129) and screenshot below.

This MR adds links to the description field.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots
Before image
After (MR diff) Screenshot_2024-06-24_at_19.23.16
After (MR widget) Screenshot_2024-06-24_at_19.22.32
Before After

How to set up and validate locally

  1. Insert full link into documentation
  2. Create MR
  3. Watch pipeline fail
  4. Go to diff, press red dot
  5. Press text on the red dot

Or to check the JSON output.

cd doc
vale ci/mobile_devops.md --output=.vale/vale-json.tmpl
Edited by Marcel Amirault

Merge request reports

Loading