letsencrypt / letsencrypt/boulder
Revise GHA prompting workflows to submit review comments, blocking merge
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 5.8k
- Forks
- 649
- Avg merge
- 3d 23h
- Merged PRs (30d)
- 24
Description
If we enjoy the github setting which blocks pull request merges until all review conversations have been resolved, then we should consider revising our workflows to submit review comments instead of issue comments.
https://github.com/letsencrypt/boulder/blob/main/.github/workflows/cps-review.yml, and https://github.com/letsencrypt/boulder/blob/main/.github/workflows/issue-for-sre-handoff.yml both use github-script, which provides an octokit client, which supports creating review comments.
It also supports subject_type:file, so the review comment is not placed on a specific line of code, but can be tied to, for example features.go when a feature flag is introduced.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with .github/workflows/cps-review.yml and .github/workflows/issue-for-sre-handoff.yml, focusing on their github-script steps and the available octokit client. Confirm how GitHub review comments with subject_type:file should be created, then update both workflows so their generated feedback is submitted as review comments and can participate in the repository's unresolved-conversation merge blocking.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, go
- Domain
- ci-cd, devops
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100