Skip to content

Conversation

@cristianrgreco
Copy link
Collaborator

@cristianrgreco cristianrgreco commented Jul 24, 2023

WHAT

Restructure the project to use NPM workspaces.

WHY

  1. Currently installing testcontainers downloads files and dependencies for all modules, which is unnecessary.
  2. Separating out testcontainers into its own module makes it easier to create new modules.

HOW

Split the testcontainers core project into its own workspace. Split each module into its own workspace. Publish the packages to the testcontainers NPM organisation following this structure:

testcontainers
@testcontainers/<module>

https://www.npmjs.com/search?q=%40testcontainers

Users can now install just the module they need:

npm install @testcontainers/postgresql

Considering this is a breaking change, this will include 2 other breaking changes:

  1. Remove deprecated lifecycle callbacks #525
  2. Add static helper for pull policy #524

@netlify
Copy link

netlify bot commented Jul 24, 2023

Deploy Preview for testcontainers-node ready!

Name Link
🔨 Latest commit 7830fb4
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-node/deploys/64ca748e57a76d0008c5ca8a
😎 Deploy Preview https://deploy-preview-621--testcontainers-node.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@cristianrgreco cristianrgreco self-assigned this Jul 28, 2023
@cristianrgreco
Copy link
Collaborator Author

/windows-test

@cristianrgreco cristianrgreco added enhancement New feature or request major An incompatible API change labels Jul 31, 2023
@cristianrgreco cristianrgreco changed the title NPM workspaces Separate testcontainers and modules into workspaces and publish as distinct packages into the testcontainers NPM organisation Jul 31, 2023
@cristianrgreco cristianrgreco marked this pull request as ready for review July 31, 2023 11:31
@cristianrgreco cristianrgreco added this to the 10.0.0 milestone Aug 3, 2023
@cristianrgreco cristianrgreco merged commit c97e294 into main Aug 3, 2023
@cristianrgreco cristianrgreco deleted the workspaces-exp branch August 3, 2023 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request major An incompatible API change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants