Skip to content

[BUG] The Changelog Verifier GitHub Action runs 26 times and sends 26 emails if changelog is omitted #13013

@dbwiddis

Description

@dbwiddis

Describe the bug

The Changelog Verifier GitHub Action triggers when a review is requested.

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

  1. Submit a PR to OpenSearch that does not include a change log entry.
  2. Check your email.
  3. Count 26 emails.
  4. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    BuildBuild Tasks/Gradle Plugin, groovy scripts, build tools, Javadoc enforcement.bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions