Skip to content

ci: Warn of missing expected specs changes

Mark Florian requested to merge danger-require-test-changes into main

What does this MR do?

This adds Dangerfile that warns about missing spec changes.

The algorithm is simple: based on filename heuristics, if a component or directive file changes, it checks if its corresponding spec file has changed. If not, it warns about it.

Initially I wanted to fail the pipeline in this case, but we'd probably want an escape hatch for MRs which do not need spec changes, e.g., refactorings, comments/docs-only changes, CSF migrations. That might be based on commit messages, or MR labels, or something like that.

So, as an MVC, I went with a warning only.

Does this MR meet the acceptance criteria?

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidlines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened in the following projects to ensure that the @gitlab/ui package can be upgraded quickly after the changes are released:
  • Added the ~"component:*" label(s) if applicable.

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.
Edited by Mark Florian

Merge request reports