debian-mirror-gitlab/danger/commit_messages/Dangerfile

143 lines
5.1 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2020-03-13 15:44:24 +05:30
require_relative File.expand_path('../../lib/gitlab/danger/commit_linter', __dir__)
2018-12-05 23:21:45 +05:30
2020-04-22 19:07:51 +05:30
COMMIT_MESSAGE_GUIDELINES = "https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html#commit-messages-guidelines"
MORE_INFO = "For more information, take a look at our [Commit message guidelines](#{COMMIT_MESSAGE_GUIDELINES})."
THE_DANGER_JOB_TEXT = "the `danger-review` job"
2020-03-13 15:44:24 +05:30
MAX_COMMITS_COUNT = 10
2020-06-23 00:09:42 +05:30
MAX_COMMITS_COUNT_EXCEEDED_MESSAGE = <<~MSG
This merge request includes more than %<max_commits_count>d commits. Each commit should meet the following criteria:
1. Have a well-written commit message.
1. Has all tests passing when used on its own (e.g. when using git checkout SHA).
1. Can be reverted on its own without also requiring the revert of commit that came before it.
1. Is small enough that it can be reviewed in isolation in under 30 minutes or so.
If this merge request contains commits that do not meet this criteria and/or contains intermediate work, please rebase these commits into a smaller number of commits or split this merge request into multiple smaller merge requests.
MSG
2018-12-05 23:21:45 +05:30
2019-12-04 20:38:33 +05:30
def gitlab_danger
@gitlab_danger ||= GitlabDanger.new(helper.gitlab_helper)
end
2020-04-22 19:07:51 +05:30
def fail_commit(commit, message, more_info: true)
self.fail(build_message(commit, message, more_info: more_info))
2018-12-05 23:21:45 +05:30
end
2020-04-22 19:07:51 +05:30
def warn_commit(commit, message, more_info: true)
self.warn(build_message(commit, message, more_info: more_info))
end
def build_message(commit, message, more_info: true)
[message].tap do |full_message|
full_message << ". #{MORE_INFO}" if more_info
full_message.unshift("#{commit.sha}: ") if commit.sha
end.join
2018-12-05 23:21:45 +05:30
end
2020-03-13 15:44:24 +05:30
def squash_mr?
2021-01-29 00:20:46 +05:30
# Locally, we assume the MR is set to be squashed so that the user only sees warnings instead of errors.
gitlab_danger.ci? ? gitlab.mr_json['squash'] : true
2018-12-05 23:21:45 +05:30
end
2020-03-13 15:44:24 +05:30
def wip_mr?
gitlab_danger.ci? ? gitlab.mr_json['work_in_progress'] : false
2018-12-05 23:21:45 +05:30
end
2020-04-22 19:07:51 +05:30
def danger_job_link
gitlab_danger.ci? ? "[#{THE_DANGER_JOB_TEXT}](#{ENV['CI_JOB_URL']})" : THE_DANGER_JOB_TEXT
end
2020-03-13 15:44:24 +05:30
# Perform various checks against commits. We're not using
# https://github.com/jonallured/danger-commit_lint because its output is not
# very helpful, and it doesn't offer the means of ignoring merge commits.
def lint_commit(commit)
linter = Gitlab::Danger::CommitLinter.new(commit)
2019-12-26 22:10:19 +05:30
2019-07-07 11:18:12 +05:30
# For now we'll ignore merge commits, as getting rid of those is a problem
# separate from enforcing good commit messages.
2020-03-13 15:44:24 +05:30
return linter if linter.merge?
2019-07-07 11:18:12 +05:30
# We ignore revert commits as they are well structured by Git already
2020-03-13 15:44:24 +05:30
return linter if linter.revert?
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
# If MR is set to squash, we ignore fixup commits
return linter if linter.fixup? && squash_mr?
2019-12-04 20:38:33 +05:30
2020-03-13 15:44:24 +05:30
if linter.fixup?
2020-04-22 19:07:51 +05:30
msg = "Squash or fixup commits must be squashed before merge, or enable squash merge option and re-run #{danger_job_link}."
2020-03-13 15:44:24 +05:30
if wip_mr? || squash_mr?
2020-04-22 19:07:51 +05:30
warn_commit(commit, msg, more_info: false)
2019-12-04 20:38:33 +05:30
else
2020-04-22 19:07:51 +05:30
fail_commit(commit, msg, more_info: false)
2019-12-04 20:38:33 +05:30
end
# Makes no sense to process other rules for fixup commits, they trigger just more noise
2020-03-13 15:44:24 +05:30
return linter
2019-12-04 20:38:33 +05:30
end
2019-09-30 21:07:59 +05:30
# Fail if a suggestion commit is used and squash is not enabled
2020-03-13 15:44:24 +05:30
if linter.suggestion?
unless squash_mr?
2020-04-22 19:07:51 +05:30
fail_commit(commit, "If you are applying suggestions, enable squash in the merge request and re-run #{danger_job_link}.", more_info: false)
2019-09-30 21:07:59 +05:30
end
2020-03-13 15:44:24 +05:30
return linter
2019-07-07 11:18:12 +05:30
end
2020-03-13 15:44:24 +05:30
linter.lint
end
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
def lint_mr_title(mr_title)
commit = Struct.new(:message, :sha).new(mr_title)
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
Gitlab::Danger::CommitLinter.new(commit).lint_subject("merge request title")
end
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
def count_non_fixup_commits(commit_linters)
commit_linters.count { |commit_linter| !commit_linter.fixup? }
end
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
def lint_commits(commits)
commit_linters = commits.map { |commit| lint_commit(commit) }
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
if squash_mr?
multi_line_commit_linter = commit_linters.detect { |commit_linter| !commit_linter.merge? && commit_linter.multi_line? }
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
if multi_line_commit_linter && multi_line_commit_linter.failed?
warn_or_fail_commits(multi_line_commit_linter)
2021-01-29 00:20:46 +05:30
commit_linters.delete(multi_line_commit_linter) # Don't show an error (here) and a warning (below)
elsif gitlab_danger.ci? # We don't have access to the MR title locally
2020-03-13 15:44:24 +05:30
title_linter = lint_mr_title(gitlab.mr_json['title'])
if title_linter.failed?
warn_or_fail_commits(title_linter)
end
end
2021-01-29 00:20:46 +05:30
else
if count_non_fixup_commits(commit_linters) > MAX_COMMITS_COUNT
self.warn(format(MAX_COMMITS_COUNT_EXCEEDED_MESSAGE, max_commits_count: MAX_COMMITS_COUNT))
end
2019-07-07 11:18:12 +05:30
end
2021-01-29 00:20:46 +05:30
failed_commit_linters = commit_linters.select { |commit_linter| commit_linter.failed? }
warn_or_fail_commits(failed_commit_linters, default_to_fail: !squash_mr?)
2020-03-13 15:44:24 +05:30
end
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
def warn_or_fail_commits(failed_linters, default_to_fail: true)
level = default_to_fail ? :fail : :warn
Array(failed_linters).each do |linter|
linter.problems.each do |problem_key, problem_desc|
case problem_key
2021-01-29 00:20:46 +05:30
when :subject_too_short, :subject_above_warning
2020-03-13 15:44:24 +05:30
warn_commit(linter.commit, problem_desc)
else
self.__send__("#{level}_commit", linter.commit, problem_desc) # rubocop:disable GitlabSecurity/PublicSend
end
end
2019-07-07 11:18:12 +05:30
end
end
2020-03-13 15:44:24 +05:30
lint_commits(git.commits)