59 lines
1.9 KiB
Ruby
59 lines
1.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# All the files/directories that should be reviewed by the Docs team.
|
|
DOCS_FILES = [
|
|
'doc/'
|
|
].freeze
|
|
|
|
def docs_paths_requiring_review(files)
|
|
files.select do |file|
|
|
DOCS_FILES.any? { |pattern| file.start_with?(pattern) }
|
|
end
|
|
end
|
|
|
|
docs_paths_to_review = docs_paths_requiring_review(helper.all_changed_files)
|
|
|
|
unless docs_paths_to_review.empty?
|
|
message 'This merge request adds or changes files that require a ' \
|
|
'review from the docs team.'
|
|
|
|
markdown(<<~MARKDOWN)
|
|
## Docs Review
|
|
|
|
The following files require a review from the Documentation team:
|
|
|
|
* #{docs_paths_to_review.map { |path| "`#{path}`" }.join("\n* ")}
|
|
|
|
When your content is ready for review, mention a technical writer in a separate
|
|
comment and explain what needs to be reviewed.
|
|
|
|
You are welcome to mention them sooner if you have questions about writing or updating
|
|
the documentation. GitLabbers are also welcome to use the [#docs](https://gitlab.slack.com/archives/C16HYA2P5) channel on Slack.
|
|
|
|
Who to ping [based on DevOps stages](https://about.gitlab.com/handbook/product/categories/#devops-stages):
|
|
|
|
| Stage | Tech writer |
|
|
| ------------- | ----------- |
|
|
| ~Create | `@marcia` |
|
|
| ~Configure | `@eread` |
|
|
| ~Distribution | `@axil` |
|
|
| ~Geo | `@eread` |
|
|
| ~Gitaly | `@axil` |
|
|
| ~Gitter | `@axil` |
|
|
| ~Manage | `@eread` |
|
|
| ~Monitoring | `@axil` |
|
|
| ~Packaging | `@axil` |
|
|
| ~Plan | `@mikelewis`|
|
|
| ~Release | `marcia` |
|
|
| ~Secure | `@axil` |
|
|
| ~Verify | `@eread` |
|
|
|
|
If you are not sure which category the change falls within, or the change is not
|
|
part of one of these categories, you can mention the whole team with `@gl-docsteam`.
|
|
MARKDOWN
|
|
|
|
unless gitlab.mr_labels.include?('Documentation')
|
|
warn 'This merge request is missing the ~Documentation label.'
|
|
end
|
|
end
|