2020-01-01 13:55:28 +05:30
# frozen_string_literal: true
2021-04-17 20:07:23 +05:30
require 'gitlab/dangerfiles/title_linting'
2021-03-08 18:12:59 +05:30
2021-03-11 19:13:27 +05:30
module Tooling
2020-01-01 13:55:28 +05:30
module Danger
module Changelog
2020-07-28 23:09:34 +05:30
NO_CHANGELOG_LABELS = [
'tooling' ,
'tooling::pipelines' ,
'tooling::workflow' ,
'ci-build' ,
'meta'
] . freeze
2020-01-01 13:55:28 +05:30
NO_CHANGELOG_CATEGORIES = % i [ docs none ] . freeze
2020-11-24 15:15:51 +05:30
CREATE_CHANGELOG_COMMAND = 'bin/changelog -m %<mr_iid>s "%<mr_title>s"'
CREATE_EE_CHANGELOG_COMMAND = 'bin/changelog --ee -m %<mr_iid>s "%<mr_title>s"'
CHANGELOG_MODIFIED_URL_TEXT = " **CHANGELOG.md was edited.** Please remove the additions and create a CHANGELOG entry. \n \n "
CHANGELOG_MISSING_URL_TEXT = " **[CHANGELOG missing](https://docs.gitlab.com/ee/development/changelog.html)**: \n \n "
2020-01-01 13:55:28 +05:30
2020-11-24 15:15:51 +05:30
OPTIONAL_CHANGELOG_MESSAGE = << ~ MSG
If you want to create a changelog entry for GitLab FOSS , run the following :
#{CREATE_CHANGELOG_COMMAND}
If you want to create a changelog entry for GitLab EE , run the following instead :
#{CREATE_EE_CHANGELOG_COMMAND}
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
2021-04-17 20:07:23 +05:30
REQUIRED_CHANGELOG_REASONS = {
db_changes : 'introduces a database migration' ,
feature_flag_removed : 'removes a feature flag'
} . freeze
2020-11-24 15:15:51 +05:30
REQUIRED_CHANGELOG_MESSAGE = << ~ MSG
To create a changelog entry , run the following :
#{CREATE_CHANGELOG_COMMAND}
2021-04-17 20:07:23 +05:30
This merge request requires a changelog entry because it [ %< reason > s ] ( https : / / docs . gitlab . com / ee / development / changelog . html #what-warrants-a-changelog-entry).
2020-11-24 15:15:51 +05:30
MSG
2021-04-17 20:07:23 +05:30
def required_reasons
[ ] . tap do | reasons |
reasons << :db_changes if project_helper . changes . added . has_category? ( :migration )
reasons << :feature_flag_removed if project_helper . changes . deleted . has_category? ( :feature_flag )
end
end
2020-11-24 15:15:51 +05:30
def required?
2021-04-17 20:07:23 +05:30
required_reasons . any?
2020-11-24 15:15:51 +05:30
end
def optional?
2020-07-28 23:09:34 +05:30
categories_need_changelog? && without_no_changelog_label?
2020-01-01 13:55:28 +05:30
end
def found
2021-04-17 20:07:23 +05:30
@found || = project_helper . changes . added . by_category ( :changelog ) . files . first
2020-01-01 13:55:28 +05:30
end
2020-04-22 19:07:51 +05:30
def ee_changelog?
found . start_with? ( 'ee/' )
2020-01-01 13:55:28 +05:30
end
2020-11-24 15:15:51 +05:30
def modified_text
CHANGELOG_MODIFIED_URL_TEXT +
2021-04-17 20:07:23 +05:30
format ( OPTIONAL_CHANGELOG_MESSAGE , mr_iid : helper . mr_iid , mr_title : sanitized_mr_title )
2020-11-24 15:15:51 +05:30
end
2021-04-17 20:07:23 +05:30
def required_texts
required_reasons . each_with_object ( { } ) do | required_reason , memo |
memo [ required_reason ] =
CHANGELOG_MISSING_URL_TEXT +
format ( REQUIRED_CHANGELOG_MESSAGE , reason : REQUIRED_CHANGELOG_REASONS . fetch ( required_reason ) , mr_iid : helper . mr_iid , mr_title : sanitized_mr_title )
end
2020-11-24 15:15:51 +05:30
end
def optional_text
CHANGELOG_MISSING_URL_TEXT +
2021-04-17 20:07:23 +05:30
format ( OPTIONAL_CHANGELOG_MESSAGE , mr_iid : helper . mr_iid , mr_title : sanitized_mr_title )
2020-11-24 15:15:51 +05:30
end
2020-01-01 13:55:28 +05:30
private
2020-11-24 15:15:51 +05:30
def sanitized_mr_title
2021-04-17 20:07:23 +05:30
Gitlab :: Dangerfiles :: TitleLinting . sanitize_mr_title ( helper . mr_title )
2020-11-24 15:15:51 +05:30
end
2020-01-01 13:55:28 +05:30
def categories_need_changelog?
2021-04-17 20:07:23 +05:30
( project_helper . changes . categories - NO_CHANGELOG_CATEGORIES ) . any?
2020-01-01 13:55:28 +05:30
end
2020-07-28 23:09:34 +05:30
def without_no_changelog_label?
2021-04-17 20:07:23 +05:30
( helper . mr_labels & NO_CHANGELOG_LABELS ) . empty?
2020-07-28 23:09:34 +05:30
end
2020-01-01 13:55:28 +05:30
end
end
end