2018-11-20 20:47:30 +05:30
# frozen_string_literal: true
2021-01-29 00:20:46 +05:30
def feature_mr?
2021-04-17 20:07:23 +05:30
( helper . mr_labels & %w[ feature::addition feature::enhancement ] ) . any?
2021-01-29 00:20:46 +05:30
end
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 : / / about . gitlab . com / handbook / engineering / ux / technical - writing / #designated-technical-writers).
For more information , see :
2021-04-17 20:07:23 +05:30
- The Handbook page on [ merge request types ] ( https : / / about . gitlab . com / handbook / engineering / metrics / #data-classification).
2021-01-29 00:20:46 +05:30
- The [ definition of done ] ( https : / / docs . gitlab . com / ee / development / contributing / merge_request_workflow . html #definition-of-done) documentation.
MSG
2021-04-17 20:07:23 +05:30
docs_paths_to_review = project_helper . changes_by_category [ :docs ]
2018-11-20 20:47:30 +05:30
2021-01-29 00:20:46 +05:30
# Documentation should be updated for feature::addition and feature::enhancement
if docs_paths_to_review . empty?
warn ( DOCUMENTATION_UPDATE_MISSING ) if feature_mr?
return
end
2020-07-28 23:09:34 +05:30
2021-01-03 14:25:43 +05:30
message 'This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is **recommended**. Reviews can happen after you merge.'
2020-07-28 23:09:34 +05:30
2021-04-17 20:07:23 +05:30
return unless helper . ci?
2018-11-20 20:47:30 +05:30
2020-07-28 23:09:34 +05:30
markdown ( << ~ MARKDOWN )
## Documentation review
2018-11-20 20:47:30 +05:30
2020-07-28 23:09:34 +05:30
The following files require a review from a technical writer :
2018-11-20 20:47:30 +05:30
2020-07-28 23:09:34 +05:30
* #{docs_paths_to_review.map { |path| "`#{path}`" }.join("\n* ")}
2018-11-20 20:47:30 +05:30
2020-07-28 23:09:34 +05:30
The review does not need to block merging this merge request . See the :
2019-02-15 15:39:39 +05:30
2021-04-17 20:07:23 +05:30
- [ 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 : / / about . gitlab . com / handbook / engineering / technical - writing / #designated-technical-writers) for that stage and group.
2020-07-28 23:09:34 +05:30
- [ Documentation workflows ] ( https : / / docs . gitlab . com / ee / development / documentation / workflow . html ) for information on when to assign a merge request for review .
MARKDOWN