gin-jwt icon indicating copy to clipboard operation
gin-jwt copied to clipboard

Document breaking API changes

Open buildscientist opened this issue 7 years ago • 4 comments

Hello @appleboy

Would it be possible for you to report breaking changes to the core API before releasing newer versions? A small mention in your release notes would go a long way.

For example - going from v2.4.0 to v2.5.0 breaks GinJWTMiddleware.Authenticator() - see the diff here for more details.

Your commit log stated that was a "refactor". By definition a refactor does not change behavior of the API.

Thank you.

buildscientist avatar Oct 09 '18 21:10 buildscientist

As an aside it looks like this was also an issue in #132.

buildscientist avatar Oct 09 '18 21:10 buildscientist

@buildscientist OK. I will write changelog. Thanks.

appleboy avatar Oct 10 '18 00:10 appleboy

I don't mind helping out either. How can I get in touch with you?

buildscientist avatar Oct 10 '18 00:10 buildscientist

Nevermind - I see your email on your profile page :)

buildscientist avatar Oct 10 '18 00:10 buildscientist