Skip to content
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

Generate the CHANGELOG for webdev and dwds as part of the release process #2083

Closed
wants to merge 8 commits into from

Conversation

elliette
Copy link
Contributor

@elliette elliette commented Apr 10, 2023

Work towards #2085

The release script auto-populates the CHANGELOG with all of the commits since the last release in the format:

- Release commit message. - [#PR number](PR url)

@natebosch
Copy link
Member

I don't think this type of automation is a good idea. Commit messages and Changelogs have different audiences, and I don't think we should conflate them.

@elliette
Copy link
Contributor Author

I don't think this type of automation is a good idea. Commit messages and Changelogs have different audiences, and I don't think we should conflate them.

Oh interesting! This is what DevTools has been doing for a while (see flutter/devtools#5603). What do you see as the difference between commit messages and CHANGELOG?

@natebosch
Copy link
Member

This is what DevTools has been doing for a while (see flutter/devtools#5603)

This is a good example of why I think it's a bad idea (cc @jacob314 @kenzieschmoll )

This is a very noisy changelog to parse through, with entries that end users don't care about. It's harder to find the changes that are meaningful to the users when they have to scan over stuff like

  • Updated getListHelper instance ref argument to be nullable
  • Add actions to DevToolsScaffold by default
  • Updating from 2.23.0-dev.28 to 2.23.0-dev.29
  • Updating from 2.23.0-dev.27 to 2.23.0-dev.28
  • Updating from 2.23.0-dev.26 to 2.23.0-dev.27
  • Automation improvements for the release process
  • Move some items out of adopted_heap_data.dart to make it observable
  • Fix golden test failures at master
  • Polish for memory instances table cell

And over 100 other entries which likely mean nothing to them, before they hit an entry that they may be interested in

  • Add profile stats to the CPU profiler

@jakemac53
Copy link
Contributor

+1 I would not do this, compare that changelog to the one in package:test https://github.com/dart-lang/test/blob/master/pkgs/test/CHANGELOG.md. This is a far more user centric changelog imo, with only the information that is actually relevant to a consumer of the package.

@elliette
Copy link
Contributor Author

Closing in favor of #2090

@elliette elliette closed this Apr 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants