-
Notifications
You must be signed in to change notification settings - Fork 9
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
tmp-promise@2.1.0 contains a breaking change and should be republished as 3.0.0 #43
Comments
tmp-promise@2.1.0
contains a breaking change
I will unpublish immediately and republish with an appropriate version number. Apologies. |
|
Hey, I deprecated 2.1.0 with a warning and published 3.0.0. I tested this locally and didn't run into the issue, if you can contribute a test to make sure I don't make this sort of mistake in the future I would appreciate it. |
Would it be appropraite to publish a 2.2.0 using tmp ^0.1.0 ? |
Thanks for reacting quickly! Don't worry about the mistake, it happens :) Normally minor version bumps are backwards-compatible, but this is only true if the major version component is 1 or higher. When the major version component is 0, then minor version components convey the breaking nature of changes. That's a quirk of SemVer (Semantic Versioning).
Versioning issues are pretty hard to guard against with automated tests, so unfortunately I don't really see what I could contribute. Normally I'd be happy to open a PR for this.
That's a good idea. I think you could republish the previous version (2.0.2) as 2.1.1 with a note saying it's reverting 2.1.0, which was yanked - that's pretty much how the SemVer spec recommends dealing with these versioning mistakes. With the deprecation notice for 2.1.0, that should cover any case of people using |
Or if it's simpler, manually fix the dependency and set the version to 2.1.1 to have the same effect. |
Hey, I published 2.1.1 that depends on 0.1.0 - I'm not too happy with this because 2.1.0 is still out there with the bad dependency but nothing I can do. Thanks for the report and responsiveness and humble apologies 🙏 |
Don't worry about those in the wilds - either it'll work for the consumers of they'll be looking for a fix soon, and now they'll find it ;) |
The change introduced by #42 bumps the
tmp
dependencies from0.1.0
to^0.2.0
.tmp@0.2.0
actually contains a breaking change overtmp@0.1.0
which will affect consumers oftmp-promise
since it is a pluggable wrapper that directly exposestmp
, so the proper version oftmp-promise
should be3.0.0
rather than2.1.0
.An example of a breaking change is the use of
tmp.dir({ dir: '/etc/arbitrary-path' })
, which is no longer allowed in0.2.0
(see raszi/node-tmp#250).The text was updated successfully, but these errors were encountered: