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

v2.2.0 has breaking changes, should not be a minor #94

Closed
msanzv opened this issue Jun 11, 2019 · 4 comments
Closed

v2.2.0 has breaking changes, should not be a minor #94

msanzv opened this issue Jun 11, 2019 · 4 comments

Comments

@msanzv
Copy link

msanzv commented Jun 11, 2019

Yesterday our signup page stopped working because the form wasn't validating, and after an afternoon of investigation, we tracked it down to this library.

The changes in v2.2.0, specifically in commit b5187c2, changed the API quite a lot by both changing the names of the emitted events and also adding a parameter in one of them. I think those kind of changes belong to a major version, or at least to a version that accepts both APIs and marks the old one as deprecated in the docs.

I already tracked it down and made those changes, but this will probably happen to everyone using those events, so writing this here in case case it helps others.

@msanzv
Copy link
Author

msanzv commented Jun 11, 2019

I suggest making this backwards-compatible by emitting both events (and adding a deprecation note in the docs). Something like:

onEnter() {
  this.$emit('enter');
  this.$emit('onEnter');
},

And in the case of the new parameter added to this.$emit('input'), I suggest moving it to the last position, because implementations using previous versions are expecting the response in that position.

@iamstevendao
Copy link
Owner

@msanzv. Sorry and thanks for your help! I would definitely take a look into it this weekend. Along with the backwards-compatible changes, I might add the releases of Github but I'm not sure it would be a good practise. Any recommendation?

@iamstevendao
Copy link
Owner

Fixed in v2.2.5 (83f2737)

@msanzv
Copy link
Author

msanzv commented Jun 16, 2019

Thank you!

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

No branches or pull requests

2 participants