warn('This merge request is currently in review. '
'It should not be merged until it is marked with the *LGTM* label.')
-###############################################################################
-# 'CHANGES' FILE
-###############################################################################
-#
-# FAIL if any of the following is true:
-#
-# * The merge request does not update the CHANGES file, but it does not have
-# the "No CHANGES" label set. (This attempts to ensure that the author of
-# the MR did not forget about adding a CHANGES entry.)
-#
-# * The merge request updates the CHANGES file, but it has the "No CHANGES"
-# label set. (This attempts to ensure that the "No CHANGES" label is used in
-# a sane way.)
-#
-# * The merge request adds any placeholder entries to the CHANGES file, but it
-# does not target the "main" branch.
-#
-# * The merge request adds a new CHANGES entry that is not a placeholder and
-# does not contain any GitLab/RT issue/MR identifiers.
-
-changes_modified = 'CHANGES' in modified_files
-no_changes_label_set = 'No CHANGES' in mr_labels
-if not changes_modified and not no_changes_label_set:
- fail('This merge request does not modify `CHANGES`. '
- 'Add a `CHANGES` entry or set the *No CHANGES* label.')
-if changes_modified and no_changes_label_set:
- fail('This merge request modifies `CHANGES`. '
- 'Revert `CHANGES` modifications or unset the *No Changes* label.')
-
-changes_added_lines = added_lines(target_branch, ['CHANGES'])
-placeholders_added = lines_containing(changes_added_lines, '[placeholder]')
-identifiers_found = filter(issue_or_mr_id_regex.search, changes_added_lines)
-if changes_added_lines:
- if placeholders_added:
- if target_branch != 'main':
- fail('This MR adds at least one placeholder entry to `CHANGES`. '
- 'It should be targeting the `main` branch.')
- elif not any(identifiers_found):
- fail('No valid issue/MR identifiers found in added `CHANGES` entries.')
-
-###############################################################################
-# RELEASE NOTES
-###############################################################################
-#
-# - FAIL if any of the following is true:
-#
-# * The merge request does not update release notes and has the "Release
-# Notes" label set. (This attempts to point out missing release notes.)
-#
-# * The merge request updates release notes but does not have the "Release
-# Notes" label set. (This ensures that merge requests updating release
-# notes can be easily found using the "Release Notes" label.)
-#
-# - WARN if any of the following is true:
-#
-# * This merge request does not update release notes and has the "Customer"
-# label set. (Except for trivial changes, all merge requests which may
-# be of interest to customers should include a release note.)
-#
-# * This merge request updates release notes, but no GitLab/RT issue/MR
-# identifiers are found in the lines added to the release notes by this
-# MR.
-
-release_notes_regex = re.compile(r'doc/(arm|notes)/notes-.*\.(rst|xml)')
-release_notes_changed = list(filter(release_notes_regex.match, modified_files))
-release_notes_label_set = 'Release Notes' in mr_labels
-if not release_notes_changed:
- if release_notes_label_set:
- fail('This merge request has the *Release Notes* label set. '
- 'Add a release note or unset the *Release Notes* label.')
- elif 'Customer' in mr_labels:
- warn('This merge request has the *Customer* label set. '
- 'Add a release note unless the changes introduced are trivial.')
-if release_notes_changed and not release_notes_label_set:
- fail('This merge request modifies release notes. '
- 'Revert release note modifications or set the *Release Notes* label.')
-
-if release_notes_changed:
- notes_added_lines = added_lines(target_branch, release_notes_changed)
- identifiers_found = filter(issue_or_mr_id_regex.search, notes_added_lines)
- if notes_added_lines and not any(identifiers_found):
- warn('No valid issue/MR identifiers found in added release notes.')
-else:
- notes_added_lines = []
-
-###############################################################################
-# CVE IDENTIFIERS
-###############################################################################
-#
-# FAIL if the merge request adds a CHANGES entry of type [security] and a CVE
-# identifier is missing from either the added CHANGES entry or the added
-# release note.
-
-if lines_containing(changes_added_lines, '[security]'):
- if not lines_containing(changes_added_lines, '(CVE-20'):
- fail('This merge request fixes a security issue. '
- 'Please add a CHANGES entry which includes a CVE identifier.')
- if not lines_containing(notes_added_lines, 'CVE-20'):
- fail('This merge request fixes a security issue. '
- 'Please add a release note which includes a CVE identifier.')
-
###############################################################################
# PAIRWISE TESTING
###############################################################################