danger/documentation/Dangerfile


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# frozen_string_literal: true

docs_paths_to_review = helper.changes_by_category[:docs]

unless docs_paths_to_review.empty?
  message 'This merge request adds or changes files that require a review ' \
    'from the Technical Writing team.'

  markdown(<<~MARKDOWN)
## Documentation review

The following files require a review from a technical writer:

* #{docs_paths_to_review.map { |path| "`#{path}`" }.join("\n* ")}

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

- [DevOps stages](https://about.gitlab.com/handbook/product/categories/#devops-stages) for the appropriate technical writer for this review.
- [Documentation workflows](https://docs.gitlab.com/ee/development/documentation/workflow.html) for information on when to assign a merge request for review.
  MARKDOWN

  unless gitlab.mr_labels.include?('Documentation')
    warn 'This merge request is missing the ~Documentation label.'
  end
end