-
Notifications
You must be signed in to change notification settings - Fork 79
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
RFC: Remove CLI & Standalone API (Pact Standalone Tools - Ruby), and migrate into sister package pact-js-cli #488
Labels
enhancement
Indicates new feature requests
Comments
This was referenced Jun 11, 2024
All CLI/API functionality provided by the Pact CLI tools (ruby based) now migrated as of pact-core v15.x to
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Previous issues
Relates to this PR which is now closed, but we will look to raise a new one
Problem
Removing the standalone tools from the pact-js-core project, would reduce our package size by ~250mb, and allow users to add in a companion package pact-js-cli if they wish to utilise the standalone tooling.
This will reduce the complexity of the pact-js-core project, and reduce testing times in CI
Steps
Breaking Changes
Does your proposed change include anything which would require a major version bump? If so, please detail them here. Please read the SemVer spec if you are unsure what this means.
This PR removes the binstubs, the Ruby binaries, and the API that exposed them. The following classes are removed:
The following methods have been removed from the default export and
new Pact()
:The following (all) binstubs have been removed:
User Actions
Users leveraging the standalone bin stubs, or api, would need to add
@pact-foundation/pact-js-cli
to their package.json and update their imports in code.Users not leveraging the standalone bin stubs, or api, would need to make no changes, and would see no impact bar a smaller package size.
Potential Downsides/Caveats
A clear and concise description of any downsides or caveats your change would introduce.
Thoughts from @TimothyJones
I feel the same, I think it would be quite a breaking flow to users, to remove the API access for users to call it programatically. I was one of those users who had that baked into my pipeline. I would suggest the API layer is moved over to pact-js-cli, to allow for frictionless migration.
The text was updated successfully, but these errors were encountered: