90 lines
3.1 KiB
Ruby
90 lines
3.1 KiB
Ruby
# frozen_string_literal: true
|
|
# rubocop:disable Style/SignalException
|
|
|
|
require 'yaml'
|
|
|
|
SEE_DOC = "See the [changelog documentation](https://docs.gitlab.com/ee/development/changelog.html)."
|
|
CREATE_CHANGELOG_MESSAGE = <<~MSG
|
|
If you want to create a changelog entry for GitLab FOSS, run the following:
|
|
|
|
```
|
|
bin/changelog -m %<mr_iid>s "%<mr_title>s"
|
|
```
|
|
|
|
If you want to create a changelog entry for GitLab EE, run the following instead:
|
|
|
|
```
|
|
bin/changelog --ee -m %<mr_iid>s "%<mr_title>s"
|
|
```
|
|
|
|
If this merge request [doesn't need a CHANGELOG entry](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry), feel free to ignore this message.
|
|
MSG
|
|
|
|
SUGGEST_MR_COMMENT = <<~SUGGEST_COMMENT
|
|
```suggestion
|
|
merge_request: %<mr_iid>s
|
|
```
|
|
|
|
#{SEE_DOC}
|
|
SUGGEST_COMMENT
|
|
|
|
def check_changelog_yaml(path)
|
|
raw_file = File.read(path)
|
|
yaml = YAML.safe_load(raw_file)
|
|
|
|
fail "`title` should be set, in #{gitlab.html_link(path)}! #{SEE_DOC}" if yaml["title"].nil?
|
|
fail "`type` should be set, in #{gitlab.html_link(path)}! #{SEE_DOC}" if yaml["type"].nil?
|
|
|
|
return if helper.security_mr?
|
|
|
|
cherry_pick_against_stable_branch = helper.cherry_pick_mr? && helper.stable_branch?
|
|
|
|
if yaml["merge_request"].nil?
|
|
mr_line = raw_file.lines.find_index("merge_request:\n")
|
|
|
|
if mr_line
|
|
markdown(format(SUGGEST_MR_COMMENT, mr_iid: gitlab.mr_json["iid"]), file: path, line: mr_line.succ)
|
|
else
|
|
message "Consider setting `merge_request` to #{gitlab.mr_json["iid"]} in #{gitlab.html_link(path)}. #{SEE_DOC}"
|
|
end
|
|
elsif yaml["merge_request"] != gitlab.mr_json["iid"] && !cherry_pick_against_stable_branch
|
|
fail "Merge request ID was not set to #{gitlab.mr_json["iid"]}! #{SEE_DOC}"
|
|
end
|
|
rescue Psych::SyntaxError, Psych::DisallowedClass, Psych::BadAlias
|
|
# YAML could not be parsed, fail the build.
|
|
fail "#{gitlab.html_link(path)} isn't valid YAML! #{SEE_DOC}"
|
|
rescue StandardError => e
|
|
warn "There was a problem trying to check the Changelog. Exception: #{e.class.name} - #{e.message}"
|
|
end
|
|
|
|
def check_changelog_path(path)
|
|
ee_changes = helper.all_ee_changes.dup
|
|
ee_changes.delete(path)
|
|
|
|
if ee_changes.any? && !changelog.ee_changelog?
|
|
warn "This MR has a Changelog file outside `ee/`, but code changes in `ee/`. Consider moving the Changelog file into `ee/`."
|
|
end
|
|
|
|
if ee_changes.empty? && changelog.ee_changelog?
|
|
warn "This MR has a Changelog file in `ee/`, but no code changes in `ee/`. Consider moving the Changelog file outside `ee/`."
|
|
end
|
|
end
|
|
|
|
def sanitized_mr_title
|
|
helper.sanitize_mr_title(gitlab.mr_json["title"])
|
|
end
|
|
|
|
if git.modified_files.include?("CHANGELOG.md")
|
|
fail "**CHANGELOG.md was edited.** Please remove the additions and create a CHANGELOG entry.\n\n" +
|
|
format(CREATE_CHANGELOG_MESSAGE, mr_iid: gitlab.mr_json["iid"], mr_title: sanitized_mr_title)
|
|
end
|
|
|
|
changelog_found = changelog.found
|
|
|
|
if changelog_found
|
|
check_changelog_yaml(changelog_found)
|
|
check_changelog_path(changelog_found)
|
|
elsif changelog.needed?
|
|
message "**[CHANGELOG missing](https://docs.gitlab.com/ee/development/changelog.html)**:\n\n" +
|
|
format(CREATE_CHANGELOG_MESSAGE, mr_iid: gitlab.mr_json["iid"], mr_title: sanitized_mr_title)
|
|
end
|