Skip to content

Make it clear that it's ok to ignore Danger's 'no changelog' warning

What does this MR do?

Based on a suggestion I made in https://gitlab.com/gitlab-org/gitlab-ce/issues/62888#note_206463212.

The idea is that Danger is only there to help the developers, not the other way around. In other words, the goal for developers isn't to clear out all the Danger message, it's to make a conscious choice based on Danger's input.

In this case, Danger is only asking if the author intended to not include a CHANGELOG entry. It's ok to ignore the message if the change doesn't warrant a CHANGELOG entry or if one was already added in a previous MR. Developers don't have to make the message go away.

We really want developers to learn the guidelines about "What warrants a changelog entry?", rather than circumventing the Throughput labels guidelines just to make Danger's warning go away.

  1. I changed the warning to a simple informative message.
  2. I removed ~Documentation and QA from this list because it's often that a ~feature MR includes ~Documentation or QA tests, so I think it's better for Danger to ask for a CHANGELOG and have the developer makes a conscious choice about one or not, than not asking for a changelog solely based on the presence of these labels.
  3. I left ~backstage ci-build and meta here because I think these labels shouldn't be ambiguous when they're set, and thus no changelog should be required in those cases.
  4. I made the message from Danger less about "CHANGELOG required" and more about "CHANGELOG is missing, please make a conscious about not adding one, and feel free to ignore this warning".
  5. I changed the wording about the labels that trigger a non-requirement of a CHANGELOG entry so that people don't read it as "If you want to get rid of this warning, add one of these labels"

The end result is the following:

Screen_Shot_2019-08-22_at_16.54.49

Edited by Rémy Coutable

Merge request reports