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

chore: Modified bug issue template to add checkbox to report potential regression. #6448

Merged

Conversation

ashishdhingra
Copy link
Contributor

Issue

Issue number, if available, prefixed with "#"

Description

  • Modified bug issue template to add checkbox to report potential regression.
  • Added GitHub action to add/remove label potential-regression when issue is created/edited.

NOTE:

  • The GitHub action code was ported from CDK repo.
  • The label potential-regression would need to be created manually (we could use color #FF6700 and description Marking this issue as a potential regression to be checked by team member to make it consistent across SDK repos)

Label potential-regression would make issue standout in the list and help engineers to handle high severity issues effectively.

Testing

How was this change tested?

Additional context

Add any other context about the PR here.

Checklist

  • If you wrote E2E tests, are they resilient to concurrent I/O?
  • If adding new public functions, did you add the @public tag and enable doc generation on the package?

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@ashishdhingra ashishdhingra requested a review from a team as a code owner September 9, 2024 17:30
id: regression
attributes:
label: Regression Issue
description: What is a regression? If it worked in a previous version but doesn't in the latest version, it's considered a regression. In this case, please provide specific version number in the report.
Copy link
Contributor

Choose a reason for hiding this comment

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

this should probably say that differences from AWS SDK for JavaScript v2 are not regressions

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this should probably say that differences from AWS SDK for JavaScript v2 are not regressions

@kuhe Thanks for the feedback. However, the purpose of this checkbox is to identify potential regression in the current major version of SDK, not differences between previous and current major version. The change is implemented across all SDK(s), JS v3 one if them.

Context: There was a regression issue in CDK and team implemented this checkbox along with GitHub action that adds potential-regression label. It was helpful in triaging such issues quickly and has assisted in identifying some regression issues till date. There is another PR for JS v2. Even though that's getting deprecated, any future security issue fixes or service updates could also cause a regression. Hence I had reopened that PR; @aBurmeseDev will discuss it with JS team.

@kuhe kuhe merged commit 6a539fe into aws:main Sep 12, 2024
1 of 2 checks passed
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