Skip to content

Conversation

@ErichDonGubler
Copy link
Member

@ErichDonGubler ErichDonGubler commented Oct 22, 2025

Builds further on #8351 by integrating our CHANGELOG check more deeply into GitHub:

  • Emit file annotations for CHANGELOG issues, so they show up in diff views for the PR. By default, this is an error message.
  • If a changelog: released entry changed label is applied to the PR, the check is run with the --warn-only flag, which emits warnings instead of errors, and emits error code 0. The check triggers on label changes, so no push is needed to apply this escape hatch.
@ErichDonGubler ErichDonGubler force-pushed the erichdongubler-push-askew-adventurous-megalodon branch 3 times, most recently from 949518d to c34aab1 Compare October 22, 2025 20:19
@ErichDonGubler ErichDonGubler added area: api Issues related to API surface and removed area: api Issues related to API surface labels Oct 22, 2025
@ErichDonGubler ErichDonGubler force-pushed the erichdongubler-push-askew-adventurous-megalodon branch 4 times, most recently from 5ec93a2 to 6a6742d Compare October 22, 2025 21:02
@ErichDonGubler
Copy link
Member Author

Screenshot of the current experience for error messages for CHANGELOG.md:

Screenshot 2025-10-22 at 5 12 44 PM
@ErichDonGubler ErichDonGubler force-pushed the erichdongubler-push-askew-adventurous-megalodon branch 2 times, most recently from adaa7a4 to 372d81d Compare October 22, 2025 21:19
@ErichDonGubler
Copy link
Member Author

I've validated that adding the escape hatch label works (CI run link), with the following experience screenshot:

Screenshot 2025-10-22 at 5 21 08 PM
@ErichDonGubler ErichDonGubler force-pushed the erichdongubler-push-askew-adventurous-megalodon branch 4 times, most recently from fcd7db1 to 0b520df Compare October 22, 2025 21:48
`<to_commit>` is the tip of the `git diff` that will be used for checking (1).
--emit-github-messages Emit GitHub workflow commands for nice integrations like error reporting in PR views.
--warn-only Only reports issues as warnings, rather than reporting errors and forcing a non-zero exit code.
Copy link
Member Author

@ErichDonGubler ErichDonGubler Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: We might add other checks. Let's make this name more specific, i.e., --allow-released-changes.

@ErichDonGubler ErichDonGubler force-pushed the erichdongubler-push-askew-adventurous-megalodon branch 5 times, most recently from 629a669 to f1bb623 Compare November 5, 2025 20:25
@ErichDonGubler ErichDonGubler force-pushed the erichdongubler-push-askew-adventurous-megalodon branch from f1bb623 to 745d7ba Compare November 6, 2025 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant