cloudflare-typescript icon indicating copy to clipboard operation
cloudflare-typescript copied to clipboard

What changed in v5.0.0?

Open Cherry opened this issue 4 months ago • 7 comments

The changelog at https://github.com/cloudflare/cloudflare-typescript/releases/tag/v5.0.0 as well as https://github.com/cloudflare/cloudflare-typescript/blob/main/CHANGELOG.md is sadly essentially unusable.

Is there a clear changelog that shows which methods have changed, what the breaking changes are (I assume there are some with a major), and if I'm safe to upgrade my implementation?

Did https://github.com/cloudflare/cloudflare-typescript/issues/2553 land? cc @jhutchings1

I was really hoping we'd start to see useful changelogs for this package (and Cloudflare's other SDKs) since I raised https://github.com/cloudflare/cloudflare-typescript/issues/1176 over a year ago.

Cherry avatar Sep 05 '25 14:09 Cherry

@Cherry Changelog improvements have been on our list, but the team has been dedicating pretty much all of our cycles to Terraform right now. I know that's not a satisfying answer, but transparently that's what's up. @KaydeeDee and team are prioritizing our list for next quarter and making a call on whether that fits in Q4.

#2553 hasn't been addressed in this particular one. That's a pretty sizable change and we need to carve off sufficient time for testing on it. Expected to get to that sooner, but Terraform pushed that down the list as well.

jhutchings1 avatar Sep 05 '25 16:09 jhutchings1

Thanks @jhutchings1, I appreciate the insight. Focusing on Terraform makes sense, but I'd just ask and encourage that in the meantime then, semver major releases for SDKs aren't pushed out if the team can't focus on documentation for changes, upgrade notes, etc. for them. These are SDKs that so many people use and rely on - please take care with releases (especially major ones) here.

https://github.com/cloudflare/cloudflare-go/releases/tag/v6.0.0 had a similar major recently with zero insight into what actually changed.

Cherry avatar Sep 05 '25 16:09 Cherry

Totally agreed. We unfortunately had some API removals that forced our hand on the semver major version. I've asked @KaydeeDee to go and get those updated with better descriptions of what the breaking changes were.

jhutchings1 avatar Sep 05 '25 16:09 jhutchings1

👀 I feel it is pretty irresponsible to have released a new major version with no usable changelog for consumers of the library... what is the expectation here, that consumers blindly upgrade and hope it works, or simply not upgrade (in which case, why release a new major)?

It could also be considered somewhat dangerous in the modern world of JS packages being compromised to be cutting releases with such unusable changelogs... as a consumer, it is pretty difficult to verify whether anything malicious has been snuck in with these changelogs as they are currently.

MattIPv4 avatar Sep 05 '25 16:09 MattIPv4

...API removals...

What I'm hearing is - we don't need to upgrade yet and you probably didn't make anything wildly incompatible for the most common use-cases...

waynesbrain avatar Sep 06 '25 21:09 waynesbrain

This issue hasn't been updated in a while. If it's still reproducing, please comment to let us know. Thank you!

github-actions[bot] avatar Nov 06 '25 16:11 github-actions[bot]

Yes, this is still reproducible, https://github.com/cloudflare/cloudflare-typescript/releases/tag/v5.0.0 + https://github.com/cloudflare/cloudflare-typescript/blob/main/CHANGELOG.md#500-2025-09-02 are still completely unusable changelogs for trying to understand what breaking changes shipped in the major release.

MattIPv4 avatar Nov 06 '25 16:11 MattIPv4