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(aws-cdk-lib): enable project references #32970

Merged
merged 2 commits into from
Jan 17, 2025

Conversation

mrgrain
Copy link
Contributor

@mrgrain mrgrain commented Jan 16, 2025

Reason for this change

Using project references in aws-cdk-lib improves the experience for other monorepo packages depending on aws-cdk-lib. A project reference to a composite package is an explicit instruction to only look at the build declaration files of the references project and not compile declarations from the .ts files again. This is opt-in from the calling package, but must be allowed from the target for some reason. Practically this improves performance for the dependant package, but also means that the package do not have to share the same TS config anymore. The latter is particularly useful if a newer package wants to impose stricter rules. Previously all these packages were effectively bound to the same (low-ish) standards.

The original opt-out was historically enabled in #8625 However the situation has drastically changes since then. Particularly aws-cdk-lib is now a single mega package, and thus much easier to handle.

Description of this change

Enables project references in aws-cdk-lib.

This exposed that we are still using some deprecated APIs in some downstream packages. Previously we didn't notice because ts compiler of the downstream package would look at the uncompiled source, which still had the deprecated type. However as part of the jsii compilation these are then removed from the type declarations (and thus jsii bindings). With project references we are now looking at the declaration files and thus any usage of deprecated APIs causes a build failure. This PR is also fixing all of these instances.

Describe any new or updated permissions being added

n/a

Description of how you validated changes

existing tests and build

Checklist


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

@aws-cdk-automation aws-cdk-automation requested a review from a team January 16, 2025 16:02
@github-actions github-actions bot added the p2 label Jan 16, 2025
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jan 16, 2025
@aws aws deleted a comment from aws-cdk-automation Jan 16, 2025
@mrgrain mrgrain marked this pull request as draft January 16, 2025 18:02
Copy link

codecov bot commented Jan 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.48%. Comparing base (3e4f377) to head (2af7ff4).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #32970   +/-   ##
=======================================
  Coverage   81.48%   81.48%           
=======================================
  Files         226      226           
  Lines       13768    13768           
  Branches     2416     2416           
=======================================
  Hits        11219    11219           
  Misses       2271     2271           
  Partials      278      278           
Flag Coverage Δ
suite.unit 81.48% <ø> (ø)

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

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

@mrgrain mrgrain force-pushed the mrgrain/chore/aws-cdk-lib/enable-project-references branch from 2952194 to fe64d2d Compare January 16, 2025 23:49
This is improves the experience for other monorepo packages depending on `aws-cdk-lib`.
@mrgrain mrgrain force-pushed the mrgrain/chore/aws-cdk-lib/enable-project-references branch from fe64d2d to 2af7ff4 Compare January 16, 2025 23:50
@mrgrain mrgrain marked this pull request as ready for review January 16, 2025 23:50
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

Copy link
Contributor

mergify bot commented Jan 17, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit b049fa8 into main Jan 17, 2025
20 checks passed
@mergify mergify bot deleted the mrgrain/chore/aws-cdk-lib/enable-project-references branch January 17, 2025 00:20
Copy link

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 Jan 17, 2025
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants