-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Description
Describe the bug
The Changelog Verifier GitHub Action triggers when a review is requested.
OpenSearch/.github/workflows/changelog_verifier.yml
Lines 1 to 4 in 2dc071f
| name: "Changelog Verifier" | |
| on: | |
| pull_request: | |
| types: [opened, edited, review_requested, synchronize, reopened, ready_for_review, labeled, unlabeled] |
Because reviews are sent to every individual listed in CODEOWNERS, the action runs once for each maintainer. This spams the email of the contributor who neglected to include a change log.
One email is probably sufficient.
Related component
Build
To Reproduce
- Submit a PR to OpenSearch that does not include a change log entry.
- Check your email.
- Count 26 emails.
- Click delete 26 times, and submit a new commit with a change log.
Or you can review the GitHub action runs for every commit and see them scrolling past the 25-run pagination break:
https://github.com/opensearch-project/OpenSearch/actions/workflows/changelog_verifier.yml
Expected behavior
One email to a PR submitter who neglected to add a change log.
Even two may be tolerable.
Perhaps three if it's more important to ensure a changelog than prevent spamming contributors' inboxes.
26 is right out.
Additional Details
Additional context
It is likely that the review_requested trigger can be removed. I'm not sure how many of the other options are really required here.