Skip to content

Better ChangeLog #2438

Closed
Closed

Description

@djmitche

Thanks for stopping by to let us know something could be better!

Is your feature request related to a problem? Please describe.

The ChangeLog for this library only says "This release has breaking changes". That's not useful information. What changed? How? What is the migration path?

Example: https://github.com/googleapis/google-api-nodejs-client/blob/master/CHANGELOG.md#6400-2020-11-05

Describe the solution you'd like

A clear and concise description of what has changed in a major release.

Describe alternatives you've considered

I realize that this package is autogenerated, and that these "has breaking changes" are per sub-component. If there are changelogs for those subcomponents, please link to them in the changelog for this package.

Activity

  1. added
    type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.
    on Nov 12, 2020
  2. willbattel commented on Nov 15, 2020

    @willbattel

    It is difficult for developers using this library to stay up to date, because every update requires us to dig unreasonably deep to figure out what has been changed, and if it breaks any of the APIs we're using. Listing the API changes on the Releases page, or at least linking to a centralized source that provides such information, would be a HUGE service to us.

    This has been requested before (here), but unfortunately yielded no response. I do greatly appreciate the improvement in recent releases, such as v58, compared to previous releases such as v51. Still not ideal but significantly better.

  3. djmitche commented on Jan 4, 2021

    @djmitche
    Author

    image

    This is definitely an improvement!

  4. bcoe commented on May 10, 2022

    @bcoe

    We've had an improved CHANGELOG for quite some time now 🎉 cleaning up some old issues.

  5. GauBen commented on Apr 12, 2023

    @GauBen

    Hey! Sorry for waking up this issue, but the change log is no longer helpful

    image

  6. djmitche commented on Apr 12, 2023

    @djmitche
    Author

    @GauBen I think you will be better-served opening a new issue and linking to this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions