Skip to content

chore(NODE-4959): use caret notation for snappy peer dependency #3526

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

Merged
merged 2 commits into from
Jan 18, 2023

Conversation

nbbeeken
Copy link
Contributor

@nbbeeken nbbeeken commented Jan 17, 2023

Description

NODE-4959

What is changing?

We decided to use the caret notation instead of .x.x notation in the non-required deps spike

What is the motivation for this change?

Consistency

Double check the following

  • Ran npm run check:lint script
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@nbbeeken nbbeeken changed the title chore(NODE-xxxx): align snappy peer version spec with other peer deps chore(NODE-4959): align snappy peer version spec with other peer deps Jan 17, 2023
@nbbeeken nbbeeken force-pushed the NODE-xxxx-fix-snappy-version-spec branch from 15618d2 to 295339b Compare January 17, 2023 18:08
@baileympearson baileympearson self-requested a review January 17, 2023 20:07
@baileympearson baileympearson added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Jan 17, 2023
package.json Outdated
@@ -34,7 +34,7 @@
},
"peerDependencies": {
"@aws-sdk/credential-providers": "^3.201.0",
"snappy": "7.x.x",
"snappy": "^7.2.2",
Copy link
Contributor

Choose a reason for hiding this comment

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

If we’re dropping support for snappy <7.2.2 (which I think is okay), let’s document this in our migration guide

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the current section to state it in the title, let me know if we should put more (though we will be revisiting it in the final cleanup ticket)

Also I ran npm install, which sorts the peerdeps and has lock file changes from FLE

@baileympearson baileympearson changed the title chore(NODE-4959): align snappy peer version spec with other peer deps chore(NODE-4959): use caret notation for snappy peer dependency Jan 18, 2023
@baileympearson baileympearson merged commit 60640e0 into main Jan 18, 2023
@baileympearson baileympearson deleted the NODE-xxxx-fix-snappy-version-spec branch January 18, 2023 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Primary Review In Review with primary reviewer, not yet ready for team's eyes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants