Replies: 1 comment
-
|
@npokc123 I totally get that this can be quite annoying and we are open for some improvements. From what I see here is that #2475 did not have a changeset which is something I overlooked and then of course this is being missed to add to the docs. From now one, we need to be more strict on what the changeset contains so we can create better changelog docs on our website. Thanks for using Kubb and the feedback. Sometimes going to fast is hurting so for sure something we need to be more aware of. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hey!
I'd like to suggest a small improvement to how changelogs are maintained. Currently, when a new version is released, the changelog sometimes only describes the "headline" feature but omits other merged PRs that also affect the generated output.
Example: v4.28.0
The changelog mentions only:
However, this release also includes at least two other PRs that change the generated code:
fix: do not override client signal if specified(listed in@kubb/plugin-react-query@4.28.0changelog but easy to miss if you're looking at changelog only)fix(plugin-react-query): respect required requestBody for oneOf mutation inputs(not mentioned in any changelog at all, as far as I can tell)Both of these PRs change the actual generated output. After upgrading from 4.27.x to 4.28.0, I saw a lot of diffs in my generated code and had a hard time figuring out whether those were expected improvements or regressions, because only the
integerTypefeature was documented.Suggestion
It would be really helpful if every change that can affect the generated output — whether it's a new feature, a bug fix, or a refactor — was explicitly listed in the changelog. This way consumers can:
I totally understand that some changes might seem minor, but from the consumer's perspective, any diff in generated code is significant and worth documenting.
Thanks for considering this!
Beta Was this translation helpful? Give feedback.
All reactions