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: Lock peer dependencies versions #8597

Merged
merged 3 commits into from Feb 15, 2022

Conversation

Bartmr
Copy link
Contributor

@Bartmr Bartmr commented Feb 1, 2022

Description of change

This PR locks down peerDependencies to their minor versions.

Why

Right now, TypeORM does not lock peer dependencies. So, if someone upgrades a major version of their database driver in their project, and that same upgrade contains breaking changes (like updating the Mongo driver to v4), noticeable and silent errors might happen.

By locking the peerDependency versions, both the build-time type-checks and the tests run in the TypeORM repo will almost guarantee that those driver versions will work, and at least warn the users if they are upgrading to a version of a database driver that still isn't tested or typechecked inside the TypeORM code-base.

What

All peer dependencies were set to the same versions that are currently set in devDependencies, since they have been type-checked during previous builds and well tested. Those that weren't previously set in devDependencies (like @sap/hana-client) were set to their latest version.

Pull-Request Checklist

  • Code is up-to-date with the master branch
  • npm run lint passes with this change
  • npm run test passes with this change
  • This pull request links relevant issues as Fixes #0000
  • There are new or updated unit tests validating the change
  • Documentation has been updated to reflect this change
  • The new commits follow conventions explained in CONTRIBUTING.md

@Bartmr Bartmr changed the title fiix: Lock peer dependencies versions fix: Lock peer dependencies versions Feb 1, 2022
@AlexMesser AlexMesser merged commit 600bd4e into typeorm:master Feb 15, 2022
@AlexMesser
Copy link
Collaborator

thank you for contribution!

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.

None yet

3 participants