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

fix(maintenance): remove upper peer dependency Middy #1705

Merged

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR removes the upper bound of the peer dependency on Middy that was introduced in the latest release.

As described in the linked issue, Powertools for AWS (TypeScript) is officially compatible only with Middy 3.x. This is documented both our documentation(see callout titled "A note about Middy") as well as Middy's documentation (here).

This is due to Middy's release cycle that favors more recent Node.js versions, which is not compatible with our current release cycle which instead is aligned with Node.js versions supported by AWS Lambda.

After making the release however, several members of the community have reached out informing us that this new strict peer dependency breaks their builds. While it's possible to circumvent the peer dependency constraint using npm's --force flag, we recognize that this doesn't constitute a good experience and so we are rolling back the change and relaxing the peer dependency constraint.

We'll revisit the topic in our upcoming major release.

Related issues, RFCs

Issue number: #1702

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

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

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi requested a review from a team as a code owner September 21, 2023 10:01
@dreamorosi dreamorosi self-assigned this Sep 21, 2023
@dreamorosi dreamorosi linked an issue Sep 21, 2023 that may be closed by this pull request
@boring-cyborg boring-cyborg bot added the dependencies Changes that touch dependencies, e.g. Dependabot, etc. label Sep 21, 2023
@pull-request-size pull-request-size bot added the size/S PR between 10-29 LOC label Sep 21, 2023
@sonarcloud
Copy link

sonarcloud bot commented Sep 21, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@github-actions github-actions bot added the bug Something isn't working label Sep 21, 2023
@am29d am29d merged commit df21ec8 into main Sep 21, 2023
12 checks passed
@am29d am29d deleted the 1702-bug-peer-dependency-conflict-with-middycore-in-version-1130 branch September 21, 2023 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dependencies Changes that touch dependencies, e.g. Dependabot, etc. size/S PR between 10-29 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Peer Dependency Conflict with @middy/core in Version 1.13.0
2 participants