Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(prlint): instructions for exemption/clarification should not be shown if already requested #28803

Closed
laurelmay opened this issue Jan 22, 2024 · 1 comment · Fixed by #29000
Closed
Assignees
Labels
bug This issue is a bug. effort/medium Medium work item – several days of effort p2 package/tools Related to AWS CDK Tools or CLI

Comments

@laurelmay
Copy link
Contributor

Describe the bug

If a contributor requests an exemption or clarification for a PR, they will get a second message (due to the comment event) telling them again that they can request an exemption/clarification. This may confuse contributors, especially beginners.

Expected Behavior

After an exemption, ideally future messages from prlinter would instead end with a message acknowledging that the exemption/clarification has been requested (but also still with the reasons for the failure).

Current Behavior

Every message ends with:

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

Reproduction Steps

  1. Open a PR with failing prlint
  2. Comment exemption request
  3. See that prlint again tells you that you could ask for an exemption request

Possible Solution

No response

Additional Information/Context

Looking over PRs in is:pr label:pr-linter/exemption-requested is:closed label:beginning-contributor show several where contributors have requested exemptions or clarifications multiple times.

CDK CLI Version

N/A

Framework Version

No response

Node.js Version

N/A

OS

N/A

Language

TypeScript

Language Version

No response

Other information

No response

@laurelmay laurelmay added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Jan 22, 2024
@github-actions github-actions bot added the package/tools Related to AWS CDK Tools or CLI label Jan 22, 2024
@pahud pahud added p2 effort/medium Medium work item – several days of effort and removed needs-triage This issue or PR still needs to be triaged. labels Jan 22, 2024
@GavinZZ GavinZZ self-assigned this Feb 6, 2024
@mergify mergify bot closed this as completed in #29000 Feb 9, 2024
mergify bot pushed a commit that referenced this issue Feb 9, 2024
…een submitted (#29000)

### Issue # (if applicable)

Closes #28803

### Reason for this change

If a contributor requests an exemption or clarification for a PR, they will get a second message (due to the comment event) telling them again that they can request an exemption/clarification. This may confuse contributors, especially beginners.

### Description of changes

Detect if an exempt request comment already exists, next comment would mention an request has been submitted and waiting for a maintainer's review.

### Description of how you validated changes

unit tests

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Copy link

github-actions bot commented Feb 9, 2024

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

TheRealAmazonKendra pushed a commit that referenced this issue Feb 9, 2024
…een submitted (#29000)

### Issue # (if applicable)

Closes #28803

### Reason for this change

If a contributor requests an exemption or clarification for a PR, they will get a second message (due to the comment event) telling them again that they can request an exemption/clarification. This may confuse contributors, especially beginners.

### Description of changes

Detect if an exempt request comment already exists, next comment would mention an request has been submitted and waiting for a maintainer's review.

### Description of how you validated changes

unit tests

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. effort/medium Medium work item – several days of effort p2 package/tools Related to AWS CDK Tools or CLI
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants