Skip to content

Conversation

@stuartmorgan-g
Copy link
Collaborator

This adds a global option to prevent the Pigeon version from being output in the generated code warning, and enables it when generating the files that are validated by CI. Since we know the files are always up to date due to the CI checks, having the version of every file change in every PR just adds noise.

Test files that haven't been consolidated into the new testing framework (mock_handler_tester, flutter_null_safe_unit_tests) still have the version for now, since they aren't yet validated by CI.

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

This adds a global option to prevent the Pigeon version from being
output in the generated code warning, and enables it when generating the
files that are validated by CI. Since we know the files are always up to
date due to the CI checks, having the version of every file change in
every PR just adds noise.

Test files that haven't been consolidated into the new testing framework
(mock_handler_tester, flutter_null_safe_unit_tests) still have the
version for now, since they aren't yet validated by CI.
@stuartmorgan-g stuartmorgan-g added override: no versioning needed Override the check requiring version bumps for most changes override: no changelog needed Override the check requiring CHANGELOG updates for most changes labels Apr 7, 2023
@stuartmorgan-g
Copy link
Collaborator Author

Overriding version and changelog; while there are production code changes here, they should be a no-op to all clients, and aren't intended for general use (although technically anyone using Pigeon as a library could set this), so there's no value in having it be its own release.

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.

How am I going to make my butter if we stop all this churn?

bool suppressVersion = false,
}) async {
return Pigeon.runWithOptions(PigeonOptions(
// Temporarily suppress the version output via the global flag if requseted.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: requested

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 7, 2023
@auto-submit auto-submit bot merged commit 3437d91 into flutter:main Apr 7, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Apr 10, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Apr 10, 2023
nploi pushed a commit to nploi/packages that referenced this pull request Jul 16, 2023
[pigeon] Remove version from most test code
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 override: no versioning needed Override the check requiring version bumps for most changes p: pigeon platform-android platform-ios platform-macos platform-windows

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants