Skip to content

Improve output and usefulness of glfm-verify job

Chad Woolley requested to merge caw-glfm-improve-glfm-verify into master

What does this MR do and why?

Related: Tracking Issue: Implement GLFM scripts per the ... (#361241 - closed)

This MR is a follow-up improvement to the glfm-verify job and verify-all-generated-files-are-up-to-date.rb script created in CI for GLFM verification script (!101118 - merged). See that MR for more background details.

In this MR, we:

  • Improve the output upon failure, by including a diff and improving error messages.
  • Adds all GLFM files to artifacts, for easier debugging of the source of the failure.

References

See the GLFM Specification Guide development documentation for much more context on all of this work: https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/specification_guide

How to set up and validate locally

  1. Run scripts/glfm/verify-all-generated-files-are-up-to-date.rb in a clean repo and ensure it works with no errors
  2. Commit a change to any of the output specification files or example snapshot files
  3. Run scripts/glfm/verify-all-generated-files-are-up-to-date.rb in a clean repo and ensure it prints a descriptive error message
  4. To test the job on CI, push the committed change on the MR and see the glfm-verify job fail. Example: https://gitlab.com/gitlab-org/gitlab/-/jobs/3281088476

MR 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