Convert paypal-js to a monorepo with Changesets and npm workspaces #453
+12,505
−8,868
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
wsbrunson
changed the title
gregjopa
reviewed
Feb 6, 2024
gregjopa
reviewed
Feb 6, 2024
gregjopa
reviewed
Feb 6, 2024
westeezy
reviewed
Feb 6, 2024
westeezy
approved these changes
Feb 6, 2024
jshawl
approved these changes
Feb 7, 2024
cgdibble
approved these changes
Feb 8, 2024
elizabethmv
approved these changes
Feb 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The motivation for this change is to create a central repository for all of PayPal's JS SDK libraries that are intended for merchant use. We'd like this to be the one place to go to find framework-specific SDK wrappers, helper libraries, and constants/types. We'd also like it to be the single place where developers can open Github Issues about the PayPal SDK.
There are 2 changes to discuss that impact the workflow. We are heavily borrowing from grumbler-scripts if you'd like to see a current working example.
Note: I'm turning off prettier checking for now so that we don't mess up the diff too badly. Once this is merged, I'm going to create a separate PR to upgrade the version of prettier and remove any config options so that we are using the base prettier options.
Moving to Changesets
Before, this repo was using standard commits to manage versioning and changelogs. Its a nice tool for simple usecases but something like Changesets makes managing packages in a monorepo incredibly simple. It also doesn't require any formatting for commit messages, it has a cli helper to create a changelog entry and determine the type of change (patch, minor, major). Changesets will handle versioning each package and deploying them to npm.
NPM workspaces
The root package.json has a
workspacesproperty now pointing to the/packagesfolder. You can learn more about workspaces here. The general gist is that they are a great way to handle repositories with multiple npm packages provided directly from the npm team.In the future, we could consider a solution like Turbo if our requirements get more complicated. For now though, workspaces should suffice.