Commit a63b0b52 authored by Rémy Coutable's avatar Rémy Coutable

Clarify that the 'EE' trailer is needed for EE changelog commits

Signed-off-by: default avatarRémy Coutable <remy@rymai.me>
parent a03b4a81
...@@ -92,7 +92,7 @@ RSpec.describe Tooling::Danger::Changelog do ...@@ -92,7 +92,7 @@ RSpec.describe Tooling::Danger::Changelog do
allow(changelog).to receive(:ee_changelog?).and_return(false) allow(changelog).to receive(:ee_changelog?).and_return(false)
end end
it { is_expected.to have_attributes(warnings: ["This MR changes code in `ee/`, but is missing a Changelog commit. Consider adding the Changelog trailer to at least one commit."]) } it { is_expected.to have_attributes(warnings: ["This MR changes code in `ee/`, but its Changelog commit is missing the [`EE: true` trailer](https://docs.gitlab.com/ee/development/changelog.html#gitlab-enterprise-changes). Consider adding it to your Changelog commits."]) }
end end
context "and a EE changelog" do context "and a EE changelog" do
...@@ -105,7 +105,7 @@ RSpec.describe Tooling::Danger::Changelog do ...@@ -105,7 +105,7 @@ RSpec.describe Tooling::Danger::Changelog do
context "and there are DB changes" do context "and there are DB changes" do
let(:foss_change) { change_class.new('db/migrate/foo.rb', :added, :migration) } let(:foss_change) { change_class.new('db/migrate/foo.rb', :added, :migration) }
it { is_expected.to have_attributes(warnings: ["This MR has a Changelog commit with the `EE: true` trailer, but there are database changes which [requires](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry) the Changelog commit to not have the `EE: true` trailer. Consider removing the `EE: true` trailer."]) } it { is_expected.to have_attributes(warnings: ["This MR has a Changelog commit with the `EE: true` trailer, but there are database changes which [requires](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry) the Changelog commit to not have the `EE: true` trailer. Consider removing the `EE: true` trailer from your commits."]) }
end end
end end
end end
...@@ -126,7 +126,7 @@ RSpec.describe Tooling::Danger::Changelog do ...@@ -126,7 +126,7 @@ RSpec.describe Tooling::Danger::Changelog do
allow(changelog).to receive(:ee_changelog?).and_return(true) allow(changelog).to receive(:ee_changelog?).and_return(true)
end end
it { is_expected.to have_attributes(warnings: ["This MR has a Changelog commit for EE, but no code changes in `ee/`. Consider removing the use of the `EE: true` trailer from your commits."]) } it { is_expected.to have_attributes(warnings: ["This MR has a Changelog commit for EE, but no code changes in `ee/`. Consider removing the `EE: true` trailer from your commits."]) }
end end
end end
end end
......
...@@ -23,7 +23,7 @@ module Tooling ...@@ -23,7 +23,7 @@ module Tooling
ci: <<~MSG ci: <<~MSG
If you want to create a changelog entry for GitLab FOSS, add the `Changelog` trailer to the commit message you want to add to the changelog. If you want to create a changelog entry for GitLab FOSS, add the `Changelog` trailer to the commit message you want to add to the changelog.
If you want to create a changelog entry for GitLab EE, also add the trailer `EE: true` to your commit message. If you want to create a changelog entry for GitLab EE, also [add the `EE: true` trailer](https://docs.gitlab.com/ee/development/changelog.html#gitlab-enterprise-changes) to your commit message.
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. 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 MSG
...@@ -138,15 +138,15 @@ module Tooling ...@@ -138,15 +138,15 @@ module Tooling
ee_changes = project_helper.all_ee_changes.dup ee_changes = project_helper.all_ee_changes.dup
if ee_changes.any? && !ee_changelog? && !required? if ee_changes.any? && !ee_changelog? && !required?
check_result.warning("This MR changes code in `ee/`, but is missing a Changelog commit. Consider adding the Changelog trailer to at least one commit.") check_result.warning("This MR changes code in `ee/`, but its Changelog commit is missing the [`EE: true` trailer](https://docs.gitlab.com/ee/development/changelog.html#gitlab-enterprise-changes). Consider adding it to your Changelog commits.")
end end
if ee_changes.empty? && ee_changelog? if ee_changes.empty? && ee_changelog?
check_result.warning("This MR has a Changelog commit for EE, but no code changes in `ee/`. Consider removing the use of the `EE: true` trailer from your commits.") check_result.warning("This MR has a Changelog commit for EE, but no code changes in `ee/`. Consider removing the `EE: true` trailer from your commits.")
end end
if ee_changes.any? && ee_changelog? && required_reasons.include?(:db_changes) if ee_changes.any? && ee_changelog? && required_reasons.include?(:db_changes)
check_result.warning("This MR has a Changelog commit with the `EE: true` trailer, but there are database changes which [requires](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry) the Changelog commit to not have the `EE: true` trailer. Consider removing the `EE: true` trailer.") check_result.warning("This MR has a Changelog commit with the `EE: true` trailer, but there are database changes which [requires](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry) the Changelog commit to not have the `EE: true` trailer. Consider removing the `EE: true` trailer from your commits.")
end end
check_result check_result
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment