Merge branch 'docs-document-the-ee-files-location-check-job-ee' into 'master'

Detect more CE branch patterns in scripts/ee-files-location-check

See merge request gitlab-org/gitlab-ee!4778

scripts/ee-files-location-check

@@ -10,21 +10,40 @@ WHITELIST = [
   'vendor/assets/javascripts/jasmine-jquery.js'
 ].freeze
 
-`git remote add canonical-ee https://gitlab.com/gitlab-org/gitlab-ee.git`
-`git remote add canonical-ce https://gitlab.com/gitlab-org/gitlab-ce.git`
-`git fetch canonical-ee master --quiet`
+def run_git_command(cmd)
+  puts "=> Running `git #{cmd}`"
+  `git #{cmd}`
+end
+
+run_git_command("remote add canonical-ee https://gitlab.com/gitlab-org/gitlab-ee.git")
+run_git_command("remote add canonical-ce https://gitlab.com/gitlab-org/gitlab-ce.git")
+run_git_command("fetch canonical-ee master --quiet")
 
 new_files_in_this_branch_not_at_the_ee_top_level =
-  `git diff canonical-ee/master...HEAD --name-status --diff-filter=A -- ./ ':!ee' | cut -f2`.lines.map(&:strip)
+  run_git_command("diff canonical-ee/master...HEAD --name-status --diff-filter=A -- ./ ':!ee' | cut -f2").lines.map(&:strip)
 
-ce_repo_url = ENV['CI_REPOSITORY_URL'].sub('gitlab-ee', 'gitlab-ce')
+ce_repo_url = ENV.fetch('CI_REPOSITORY_URL', 'https://gitlab.com/gitlab-org/gitlab-ce.git').sub('gitlab-ee', 'gitlab-ce')
 current_branch = ENV.fetch('CI_COMMIT_REF_NAME', `git rev-parse --abbrev-ref HEAD`).strip
-ce_branch_name = current_branch.sub(/(\Aee\-|\-ee\z)/, '')
+minimal_ce_branch_name = current_branch.sub(/(\Aee\-|\-ee\z)/, '')
+
+ls_remote_output = run_git_command("ls-remote #{ce_repo_url} \"*#{minimal_ce_branch_name}*\"")
+remote_to_fetch = 'canonical-ce'
+branch_to_fetch = 'master'
+
+if ls_remote_output.include?(minimal_ce_branch_name)
+  remote_to_fetch = ce_repo_url
+  branch_to_fetch = ls_remote_output.split("refs/heads/").last.strip
+  puts
+  puts "💪 We found the branch '#{branch_to_fetch}' in the #{ce_repo_url} repository. We will fetch it."
+else
+  puts "⚠️ We did not find a branch that would match the current '#{current_branch}' branch in the #{ce_repo_url} repository. We will fetch 'master' instead."
+  puts "ℹ️ If you have a CE branch for the current branch, make sure that its name includes '#{minimal_ce_branch_name}'."
+end
 
-`git fetch #{ce_repo_url} #{ce_branch_name} --quiet` || `git fetch canonical-ce 'master' --quiet`
+run_git_command("fetch #{remote_to_fetch} #{branch_to_fetch} --quiet")
 
 ee_specific_files_in_ce_master_not_at_the_ee_top_level =
-  `git diff FETCH_HEAD..HEAD --name-status --diff-filter=A -- ./ ':!ee' | cut -f2`.lines.map(&:strip)
+  run_git_command("diff FETCH_HEAD..HEAD --name-status --diff-filter=A -- ./ ':!ee' | cut -f2").lines.map(&:strip)
 new_ee_specific_files_not_at_the_ee_top_level =
   new_files_in_this_branch_not_at_the_ee_top_level & ee_specific_files_in_ce_master_not_at_the_ee_top_level
 
@@ -34,12 +53,21 @@ new_ee_specific_files_not_at_the_ee_top_level.each do |file|
   next if WHITELIST.any? { |pattern| Dir.glob(pattern).include?(file) }
 
   puts
-  puts "* #{file} is EE-specific and should be moved to ee/#{file}:"
+  puts "* 💥 #{file} is EE-specific and should be moved to ee/#{file}: 💥"
   puts "  => git mv #{file} ee/#{file}"
   status = 1
 end
 
-`git remote remove canonical-ee`
-`git remote remove canonical-ce`
+if status.zero?
+  puts
+  puts "🎉 All good, congrats! 🎉"
+end
+
+run_git_command("remote remove canonical-ee")
+run_git_command("remote remove canonical-ce")
+
+puts
+puts "ℹ️ For more information on the why and how of this job, see https://docs.gitlab.com/ee/development/ee_features.html#detection-of-ee-only-files"
+puts
 
 exit(status)