Skip to content

Enable release notes checks to post comment with instructions #432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nrichers merged 2 commits into from
Oct 8, 2025
Merged

Enable release notes checks to post comment with instructions #432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
778459a
Update release_notes_check.yaml
nrichers Oct 8, 2025
860b07a
Update release_notes_check.py
nrichers Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/scripts/release_notes_check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def ci_check(pr_number, access_token):
if release_notes_match:
release_notes_text = release_notes_match.group(1).strip()
if release_notes_text and release_notes_text != "<!--- REPLACE THIS COMMENT WITH YOUR DESCRIPTION --->":
comment = "Pull requests must include at least one of the required labels: `internal` (no release notes required), `highlight`, `enhancement`, `bug`, `deprecation`, `documentation`."
comment = "Pull requests must include at least one of the required labels: `internal` (no release notes required), `highlight`, `enhancement`, `bug`, `deprecation`, `documentation`. Except for `internal`, pull requests must also include a description in the release notes section."
pr.create_issue_comment(comment)
return False
# Pull request has neither a label nor a description
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release_notes_check.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:

permissions:
contents: read
pull-requests: read
pull-requests: write

jobs:
ci_check:
Expand Down
Loading