summaryrefslogtreecommitdiff
path: root/danger/changelog/Dangerfile
blob: 773ffa15a0f72c034221761bafa2c7d5d2e565e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# rubocop:disable Style/SignalException

require 'yaml'

def check_changelog(path)
  yaml = YAML.safe_load(File.read(path))

  fail "`title` should be set, in #{gitlab.html_link(path)}." if yaml["title"].nil?
  fail "`type` should be set, in #{gitlab.html_link(path)}." if yaml["type"].nil?

  if yaml["merge_request"].nil?
    message "Consider setting `merge_request` to #{gitlab.mr_json["iid"]} in #{gitlab.html_link(path)}."
  elsif yaml["merge_request"] != gitlab.mr_json["iid"]
    fail "Merge request IID was not set to #{gitlab.mr_json["iid"]}!"
  end
rescue StandardError
  # YAML could not be parsed, fail the build.
  fail "#{gitlab.html_link(path)} isn't valid YAML!"
end

changelog_needed = !gitlab.mr_labels.include?("backstage")
changelog_found = git.added_files.find { |path| path =~ %r{\A(ee/)?(changelogs/unreleased)(-ee)?/} }

if git.modified_files.include?("CHANGELOG.md")
  fail "CHANGELOG.md was edited. Please remove the additions and create an entry with `bin/changelog -m #{gitlab.mr_json["iid"]}` instead."
end

if changelog_needed
  if changelog_found
    check_changelog(path)
  else
    msg = [
      "This merge request is missing a CHANGELOG entry, you can create one with `bin/changelog -m #{gitlab.mr_json["iid"]}`.",
      "If your merge request doesn't warrant a CHANGELOG entry, consider adding the ~backstage label."
    ]

    warn msg.join(" ")
  end
end