Skip to content

Proposal: more informative changelog for stable releases #163237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
RepliedSage11 opened this issue Feb 13, 2025 · 5 comments
Closed

Proposal: more informative changelog for stable releases #163237

RepliedSage11 opened this issue Feb 13, 2025 · 5 comments
Labels
c: new feature Nothing broken; request for a new capability c: proposal A detailed proposal for a change to Flutter

Comments

@RepliedSage11
Copy link
Contributor

Use case

Whenever Flutter gets a new stable version, an announcement, a list of breaking changes and a changelog is posted. The announcement highlights the main big changes without going into much detail and omitting some smaller changes. The breaking changes list is explaining the breaking changes in-depth with examples and details, but only for the breaking changes.

On the other hand the changelog, which I would assume is the central piece in a release, is not very informative and helpful. It consists of a list of all the PRs that were merged since the last stable release, which is mostly PRs that don't change anything for the app developers. Some of these issues are relands, reverts, automated dependency rolls, unflaking tests and other things that don't (in my opinion) add any value to a changelog except for generating noise in an already not very easy to grasp list.

Real changes get lost in the list so developers might never even know that some shiny new feature was added or a long standing bug was fixed. Or they might not know if some change is intended or is a regression, which then leads to them opening an issue and wasting their and the Flutter maintainers time.

Proposal

I propose for Flutter to add changelogs that go over developer-facing changes and describe them in a human-readable way, while also linking to issues and PRs for the credits and context. It is already done for the hotfix releases, so I think this should also be done for the bigger and more feature-packed stable releases.

Dart's changelog is an ideal example of what I am proposing.

@ueman
Copy link
Contributor

ueman commented Feb 13, 2025

There's such a thing at #161460 and #121415

@RepliedSage11
Copy link
Contributor Author

Notable commits is a good initiative, but it is not a changelog by any means. These are still commits that are not always developer-facing changes and are not tied to a release.

@huycozy huycozy added in triage Presently being triaged by the triage team c: new feature Nothing broken; request for a new capability c: proposal A detailed proposal for a change to Flutter team-release and removed in triage Presently being triaged by the triage team labels Feb 14, 2025
@matanlurey
Copy link
Contributor

This is not planned at this time.

@matanlurey matanlurey closed this as not planned Won't fix, can't repro, duplicate, stale May 16, 2025
@RepliedSage11
Copy link
Contributor Author

Hi @matanlurey!
Is there a reason I am missing why this would not be a useful addition?

@RepliedSage11
Copy link
Contributor Author

At the very minimum can the PR list at least be filtered to exclude package rolls, dart rolls, reverts, marking tests as flaky etc?

As it stands now, in my opinion, the changelog provides pretty much no value to Flutter developers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: new feature Nothing broken; request for a new capability c: proposal A detailed proposal for a change to Flutter
Projects
None yet
Development

No branches or pull requests

4 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy