Release Highlights Linter
What does this MR do?
Adding a linter/validator for the release highlights ("whats new") .yaml files that will be added to the repo every month.
This code leverages ActiveModel::Validations and ties the errors back to where the error occurs in the .yaml file.
I decided to actually run the validate_all!
method in the spec in
which it's tested. Though I do feel like moving this to it's own linter
plugin could be a better place eventually.
part of: gitlab-org/growth/engineering#5403 (closed)
Does this MR meet the acceptance criteria?
Conformity
-
Changelog entry -
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
-
Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process. -
Tested in all supported browsers -
Informed Infrastructure department of a default or new setting change, if applicable per definition of done
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
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Edited by Jay