Skip to content

Add path to feature flag fallback note

James Nutt requested to merge jnutt/improve-ff-danger into master

What does this MR do and why?

Add path to feature flag fallback note

The current fallback note for an unfilled feature_issue_url: does not provide enough context to make it obvious what it's referring to. This MR adds the file path to direct the author of the MR in the right direction.

Before:

- [ ] config/feature_flags/beta/flag_with_blank_feature_url.yml#L3: Consider filling `feature_issue_url:`
- [ ] Consider filling `feature_issue_url:`

After:

- [ ] config/feature_flags/beta/flag_with_blank_feature_url.yml#L3: Consider filling `feature_issue_url:`
- [ ] config/feature_flags/beta/flag_with_missing_feature_url.yml: Consider filling `feature_issue_url:`

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.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Check out this branch.
  2. Create the following two files:
    config/feature_flags/beta/flag_with_blank_feature_url.yml:
    ---
    name: flag_with_blank_feature_url
    feature_issue_url:
    introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148889
    rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/455288
    milestone: '17.1'
    group: group::source code
    type: beta
    default_enabled: false
    config/feature_flags/beta/flag_with_missing_feature_url.yml:
    ---
    name: flag_with_missing_feature_url
    introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148889
    rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/455288
    milestone: '17.1'
    group: group::source code
    type: beta
    default_enabled: false
  3. Commit them.
  4. Run bin/rake danger_local and observe the output.

Merge request reports