aws / aws/aws-cdk

prlint: assess needs review after codebuild job succeeds

Open
#30,128 0 comments 0 reactions 0 assignees View on GitHub
bug effort/small p2 package/tools
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the bug

We refuse to assess if a PR needs review if the codebuild job is not successful. However if the pr linter runs before the codebuild job is done, it will not run again until another triggering action happens on the PR. So a situation like this might happen:

1) open a PR
2) community approves
3) build reports successful

We would like this situation to still get labeled `needs-maintainer-review` after the build is successful, but instead it will not report anything until the next trigger.

### Expected Behavior

see above

### Current Behavior

see above

### Reproduction Steps

see above

### Possible Solution

We need the codebuild job to trigger the pr linter somehow. A possible solution is to modify the github workflow to trigger on `issue_comment` as well, and filter comments for the specific one that comes from aws-cdk-automation when the build succeeds. However, this likely opens prlinter to run on all prs and issues, albeit it will skip all jobs for non prs. That might be non tenable.

Alternatively, we can finangle the codebuild step to hit one of the PR triggers when successful, like adding a new label.

### Additional Information/Context

_No response_

### CDK CLI Version

2.x

### Framework Version

_No response_

### Node.js Version

20

### OS

Mac

### Language

TypeScript

### Language Version

_No response_

### Other information

_No response_

Contributor guide

Open the contributing guide

Research direction

Inspect the prlint GitHub workflow and the CodeBuild-success notification path, starting with the workflow triggers and filtering around issue_comment or PR label events. Reproduce the sequence where approval precedes a successful build; done means the successful build causes the PR to be assessed and labeled needs-maintainer-review without another PR action.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
ci-cd, devops
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.