gitlab-foss/danger/documentation/Dangerfile

# frozen_string_literal: true

def feature_mr?
  (helper.mr_labels & %w[feature::addition feature::enhancement]).any?
end

def doc_path_to_url(path)
  path.sub("doc/", "https://docs.gitlab.com/").sub("index.md", "").sub(".md", "/")
end

docs_paths_to_review = helper.changes_by_category[:docs]

# Some docs do not need a review from a Technical Writer.
# In these cases, we'll output a message specific to the section.
sections_with_no_tw_review = {
  'doc/architecture' => [],
  'doc/development' => [],
  'doc/solutions' => [],
  'doc-locale' => []
}.freeze

# One exception to the exceptions above: Technical Writing docs should get a TW review.
TW_DOCS_PATH = 'doc/development/documentation'

docs_paths_to_review.reject! do |doc|
  section_with_no_tw_review = sections_with_no_tw_review.keys.find { |skip_path| doc.start_with?(skip_path) && !doc.start_with?(TW_DOCS_PATH) }
  next unless section_with_no_tw_review

  sections_with_no_tw_review[section_with_no_tw_review] << doc

  true
end

SOLUTIONS_LABELS = %w[Solutions].freeze
DEVELOPMENT_LABELS = ['development guidelines'].freeze

def add_labels(labels)
  helper.labels_to_add.concat(%w[documentation type::maintenance maintenance::refactor] + labels)
end

ANY_MAINTAINER_CAN_MERGE_MESSAGE = <<~MSG
This MR contains docs in the /%<directory>s directory, but any Maintainer can merge. You do not need tech writer review.
MSG

SOLUTIONS_MESSAGE = <<~MSG
This MR contains docs in the /doc/solutions directory and should be reviewed by a Solutions Architect approver. You do not need tech writer review.
MSG

LOCALIZATION_MESSAGE = <<~MSG
This MR contains files in the /doc-locale directory. These files are translations maintained through a separate process and should not be edited directly. If you are not part of the Localization team, please remove the changes to these files from your MR.
MSG

# For regular pages, prompt for a TW review
DOCS_UPDATE_SHORT_MESSAGE = <<~MSG
This merge request adds or changes documentation files and requires Technical Writing review. The review should happen before merge, but can be post-merge if the merge request is time sensitive.
MSG

DOCS_UPDATE_LONG_MESSAGE = <<~MSG.freeze
## Documentation review

The following files require a review from a technical writer:

* #{docs_paths_to_review.map { |path| "`#{path}` ([Link to current live version](#{doc_path_to_url(path)}))" }.join("\n* ")}

The review does not need to block merging this merge request. See the:

- [Metadata for the `*.md` files](https://docs.gitlab.com/ee/development/documentation/#metadata) that you've changed. The first few lines of each `*.md` file identify the stage and group most closely associated with your docs change.
- The [Technical Writer assigned](https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments) for that stage and group.
- [Documentation workflows](https://docs.gitlab.com/development/documentation/workflow/) for information on when to assign a merge request for review.
MSG

# Documentation should be updated for feature::addition and feature::enhancement
DOCUMENTATION_UPDATE_MISSING = <<~MSG
~"feature::addition" and ~"feature::enhancement" merge requests normally have a documentation change. Consider adding a documentation update or confirming the documentation plan with the [Technical Writer counterpart](https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments).

For more information, see:

- The Handbook page on [merge request types](https://handbook.gitlab.com/handbook/product/groups/product-analysis/engineering/metrics/#work-type-classification).
- The [definition of done](https://docs.gitlab.com/development/contributing/merge_request_workflow/#definition-of-done) documentation.
MSG

# Output messages
warn(DOCUMENTATION_UPDATE_MISSING) if docs_paths_to_review.empty? && feature_mr?

if sections_with_no_tw_review["doc/architecture"].any?
  message(format(ANY_MAINTAINER_CAN_MERGE_MESSAGE, directory: 'doc/architecture'))
end

if sections_with_no_tw_review["doc/development"].any?
  add_labels(DEVELOPMENT_LABELS)
  message(format(ANY_MAINTAINER_CAN_MERGE_MESSAGE, directory: 'doc/development'))
end

if sections_with_no_tw_review["doc/solutions"].any?
  add_labels(SOLUTIONS_LABELS)
  message(SOLUTIONS_MESSAGE)
end

message(LOCALIZATION_MESSAGE) if sections_with_no_tw_review["doc-locale"].any?

unless docs_paths_to_review.empty?
  message(DOCS_UPDATE_SHORT_MESSAGE)
  markdown(DOCS_UPDATE_LONG_MESSAGE)
end