Skip to content

Add feature for towncrier-run.yml to comment on PR when it fails.#361

Open
Ciemaar wants to merge 3 commits into
beeware:mainfrom
Ciemaar:towncrier-pr-comment
Open

Add feature for towncrier-run.yml to comment on PR when it fails.#361
Ciemaar wants to merge 3 commits into
beeware:mainfrom
Ciemaar:towncrier-pr-comment

Conversation

@Ciemaar
Copy link
Copy Markdown

@Ciemaar Ciemaar commented May 19, 2026

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:

  • I will abide by the BeeWare Code of Conduct
  • I have read and have followed the CONTRIBUTING.md file
  • This PR was generated or assisted using an AI tool
    Assisted-by: Jules

Copy link
Copy Markdown
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

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.

Comment thread .github/workflows/towncrier-run.yml Outdated
Comment thread .github/workflows/towncrier-run.yml Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants