Skip to content

Conversation

@samson-keung
Copy link
Contributor

Issue # (if applicable)

N/A

Reason for this change

The paragraph removed in this PR is too restrictive in defining breaking changes. It states that ANY change that may stop ANY CDK application to "not work correctly" is a breaking change. It is missing the point that we do not guarantee CDK applications that have custom logic or overriding CDK classes/methods, to not break. A recent case of this is #33319

Description of changes

Given that there is more concrete information on what defines a Breaking Change further down in CONTRIBUTING.md, I have removed the inaccurate paragraph

Checklist


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

@samson-keung samson-keung requested a review from evzzk February 10, 2025 22:01
@aws-cdk-automation aws-cdk-automation requested a review from a team February 10, 2025 22:01
@github-actions github-actions bot added the p2 label Feb 10, 2025
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Feb 10, 2025
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

(This review is outdated)

@codecov
Copy link

codecov bot commented Feb 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.92%. Comparing base (2ca12eb) to head (b4bde3b).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #33368   +/-   ##
=======================================
  Coverage   80.92%   80.92%           
=======================================
  Files         236      236           
  Lines       14253    14253           
  Branches     2490     2490           
=======================================
  Hits        11534    11534           
  Misses       2434     2434           
  Partials      285      285           
Flag Coverage Δ
suite.unit 80.92% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk 79.73% <ø> (ø)
packages/aws-cdk-lib/core 82.20% <ø> (ø)

@samson-keung samson-keung added the pr/do-not-merge This PR should not be merged at this time. label Feb 10, 2025
@samson-keung samson-keung changed the title chore: Update definition of breaking change in CONTRIBUTING.md chore: update definition of breaking change in CONTRIBUTING.md Feb 10, 2025
@aws-cdk-automation aws-cdk-automation dismissed their stale review February 10, 2025 22:21

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: b4bde3b
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Feb 10, 2025
programs that customers could have been writing against the current version
of the CDK, that will no longer "work correctly" with the proposed new
version of the CDK.

Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add "reason for this change" explanation to the readme possibly with the issue pointer? Its a great explanation. Removing this section will open up a debate on what and what is not a breaking change.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Feb 11, 2025
@github-actions
Copy link
Contributor

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 11, 2025
@samson-keung samson-keung deleted the update-contribution-doc branch March 11, 2025 21:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

contribution/core This is a PR that came from AWS. p2 pr/do-not-merge This PR should not be merged at this time.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants