Skip to content

Add a reason when skipping a criterion

Quang-Minh Nguyen requested to merge qmnguyen0711/add-a-reason-when-skipping-a-criterion into master

For gitlab-com/gl-infra/scalability#1355 (closed)

In gitlab-com/gl-infra/scalability#826 (closed), we made it possible to skip a criterion. When looking back the skip list, people usually forget the reason why a service criterion is skipped. We have too many services for all an individual brain to remember. Other people may raise this question again. So, I think it makes sense to add a reason whenever a criterion is skipped.

Before (inside a service manifest):

  skippedMaturityCriteria: maturityLevels.getCriterias([
    'Service exists in the dependency graph',
  ]),

After

  skippedMaturityCriteria: maturityLevels.skip({
    'Service exists in the dependency graph': 'This service is managed by GKE at the moment. It does not interfact directly with any other services',
  }),

The reason is added to the evidence field of the maturity manifest file. This MR also changes the shape of service_maturity.yml file to include max level info. We'll need to update the handbook to adapt to this new shape, and display the reason for skipped criteria.

Merge request reports