automatically validate PR release note entries at PR creation time
#21,462 opened on Nov 30, 2023
Repository metrics
- Stars
- (15,558 stars)
- PR merge metrics
- (Avg merge 34d 14h) (120 merged PRs in 30d)
Description
Similar to Issue #21342, add automation to validate the Release Note section of a PR either at or immediately after creation time.
Expected Behavior or Use Case
If a PR contains a valid release note entry (examples: #21399 , #21458 ), nothing happens.
If a PR contains an invalid release note entry (see Example Screenshots for examples), a comment could be added similar to how the linux-foundation-easycla bot adds a comment when an author does not have a signed CLA on file.
The comment would contain text and links to help the PR's author revise the Release Notes section of their PR.
Presto Component, Service, or Connector
GitHub PR in the Presto repository.
Possible Implementation
Perhaps a GitHub Action, or a bash script, could be used that would run when a PR is opened.
Example Screenshots (if appropriate):
Invalid release note entry categories:
-
An unedited Release Note prompt block.
-
Nothing at all - the Release Note prompt block is deleted. (no screenshot)
-
A valid release note, but didn’t delete “Please follow” line.
Note: Maybe “didn’t delete “Please follow” line” should not be a failure. Maybe the automation can delete that line.
- A valid release note, but didn’t delete “If release note is NOT required, use:”
Note: Maybe “didn’t delete “If release note is NOT required, use:” should not be a failure. Maybe the automation can delete that line.
-
A valid release note, but didn’t delete either the “Please follow” line, the “If release note is NOT required, use:” line, or the “No release note” block.
-
An incorrectly formatted "No Release Notes" entry.
Context
The goal is to validate that the Release Note section of a PR is present and correctly formatted. This helps reviewers review the PR, and helps the assembly and review of the Release Notes for a given Presto release.