Skip to content

Conversation

@EchoEllet
Copy link
Contributor

Replace a deprecated command in the instructions of using pigeon.

Running flutter pub run pigeon --input path/to/input.dart will output the following at the start of the output:

Deprecated. Use `dart run` instead.

Pre-launch Checklist

Running `flutter pub run pigeon --input path/to/input.dart` will output `Deprecated. Use `dart run` instead.` at the start of the output.
@EchoEllet EchoEllet marked this pull request as ready for review September 26, 2024 14:03
@tarrinneal
Copy link
Contributor

Good catch! This will need an update to the changelog, I think a NEXT entry would be fine for this. @stuartmorgan is that the case for this? And tagged for second review once that is done.

@EchoEllet
Copy link
Contributor Author

EchoEllet commented Sep 27, 2024

Thank you for reviewing the change, IMO CHANGELOG.md is for the end user or the developer who will use the package, such minor changes are not in the list of interest for most users, and I think CHANGELOG.md should be different from Git log or the commit history. Such projects have many of those changes and having them all in a CHANGELOG.md will result in users not reading them even if it has critical changes, features, deprecation, or breaking changes. User expect that docs up to to date with related repositories. See Keep a Changelog
as an example format for CHANGELOG.md.

Though I can add it if needed.

@tarrinneal
Copy link
Contributor

Thank you for reviewing the change, IMO CHANGELOG.md is for the end user or the developer who will use the package, such minor changes are not in the list of interest for most users, and I think CHANGELOG.md should be different from Git log or the commit history. Such projects have many of those changes and having them all in a CHANGELOG.md will result in users not reading them even if it has critical changes, features, deprecation, or breaking changes. User expect that docs up to to date with related repositories. See Keep a Changelog as an example format for CHANGELOG.md.

Though I can add it if needed.

The issue is that README changes don't get published without a new version, I could wrap this change up in another pr I'm making to avoid the issue, or @stuartmorgan could grant an exception for this case.

@EchoEllet
Copy link
Contributor Author

EchoEllet commented Sep 27, 2024

if they can grant an exception, I would wait. Otherwise, if you prefer to have this change documented in CHANGELOG.md, I will update the file to mention this change.

@stuartmorgan-g
Copy link
Collaborator

This README isn't published, because pub.dev prioritizes example/lib/main.dart (unfortunately, in this case, since that's empty) over example/README.txt, which is why it's not failing the version check. It's fine to CHANGELOG-exempt this; the only reason changes to unpublished example files aren't auto-exempted from the CHANGELOG check is because sometimes changes to example files are relevant to people understanding the package, such as adding a missing permission to the example app that a real app would need, so we add a human check.

@stuartmorgan-g stuartmorgan-g added the override: no changelog needed Override the check requiring CHANGELOG updates for most changes label Sep 27, 2024
@stuartmorgan-g
Copy link
Collaborator

CHANGELOG override: minor update to instructions for local running.

Copy link
Collaborator

@stuartmorgan-g stuartmorgan-g left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@tarrinneal tarrinneal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, there ya go! Thanks for putting this together!

@tarrinneal tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 28, 2024
@auto-submit auto-submit bot merged commit 03e1bfa into flutter:main Sep 28, 2024
@EchoEllet EchoEllet deleted the patch-2 branch September 28, 2024 07:58
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Sep 30, 2024
flutter/packages@0321757...27c9853

2024-09-28 [email protected] [pigeon] fix int bug (flutter/packages#7725)
2024-09-28 [email protected] [pigeon] update deprecated command in README of the example (flutter/packages#7709)
2024-09-27 [email protected] [google_maps_flutter] Fix incorrect comment: Change "marker" to "polyline" (flutter/packages#7664)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC [email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
thejitenpatel pushed a commit to thejitenpatel/flutter that referenced this pull request Oct 1, 2024
flutter/packages@0321757...27c9853

2024-09-28 [email protected] [pigeon] fix int bug (flutter/packages#7725)
2024-09-28 [email protected] [pigeon] update deprecated command in README of the example (flutter/packages#7709)
2024-09-27 [email protected] [google_maps_flutter] Fix incorrect comment: Change "marker" to "polyline" (flutter/packages#7664)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC [email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App override: no changelog needed Override the check requiring CHANGELOG updates for most changes p: pigeon

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants