Add a changelog about flask-cors HOT 6 CLOSED

Hey Greg,

Sorry for the trouble, you are completely right. I would prefer to manage the release log with one source of truth, and have been trying to use Github releases to provide this information, but it is not as discoverable.

Short term, you can see the list of breaking changes here: https://github.com/corydolphin/flask-cors/releases/tag/2.0.0. 2.0.0 was largely a cleanup and fixup of some strange edge cases caused by my initial implementation.

Longterm, I will throw a script together to grab release notes from Github and write them into a CHANGELOG for posterity. This also made me realize that Github is being a little bit tricky with their releases. Though it creates a get tag, it doesn't store the release notes in the tag's message, sadly.

from flask-cors.

Oh, I didn't even look there.

It might be worth sticking a dummy CHANGELOG file in there with a URL to that releases link. Maybe reference it in the README, too. That'd keep most pretty happy, probably!

from flask-cors.

Good call! Love the suggestion.

Out of interest, did you decide to switch to 2.0.0? If not, I'd love to
hear if the changes were incompatible with your use case.

I find it hard to know how people use the package, so I keep trying to best
balance my use cases and how I expect people will use it.

Cheers,
Cory
On Wed, Mar 25, 2015 at 9:07 PM Greg Taylor [email protected]
wrote:

Oh, I didn't even look there.

It might be worth sticking a dummy CHANGELOG file in there with a URL to
that releases link. Maybe reference it in the README, too. That'd keep most
pretty happy, probably!

—
Reply to this email directly or view it on GitHub
#118 (comment)
.

from flask-cors.

Added in #121.

I think it is a great idea to keep track of it separate from Github, and will start to do so.

from flask-cors.

Excellent work! Thanks for doing that. We feel better already!

from flask-cors.

Glad to hear it! Please drop me a line if there are any questions, or if you have any feedback :-)

Cory

from flask-cors.