Add feature for towncrier-run.yml to comment on PR when it fails. - #361
Merged
freakboy3742 merged 3 commits intoMay 26, 2026
Merged
Add feature for towncrier-run.yml to comment on PR when it fails.#361freakboy3742 merged 3 commits into
freakboy3742 merged 3 commits into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
3 tasks
freakboy3742
approved these changes
May 20, 2026
freakboy3742
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Thanks! A couple of minor tweaks to maintain a consistent voice, but otherwise, this looks great. I'm doing some testing of this with beeware/toga-chart#327; assuming it all works, I'll merge this.
Sorry, something went wrong.
Comment thread
.github/workflows/towncrier-run.yml
Outdated
Comment thread
.github/workflows/towncrier-run.yml
Outdated
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a step to the towncrier-run.yml GitHub Action workflow to automatically post a comment on pull requests when the towncrier check fails. The comment directs the developer to the BeeWare contribution guide for adding change notes. To prevent duplicate comments on the same PR, it includes a hidden HTML comment identifier and uses gh api and jq to check if a comment with the identifier already exists before posting. It also adds the necessary pull-requests: write permissions.
This is intended to reduce maintainer load in these cases.
PR Checklist:
Assisted-by: Jules