Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore: Don't unconditionally check tools/gn formatting#182973

Merged
auto-submit[bot] merged 2 commits intoflutter:masterfrom
harryterkelsen:align-python-format-gn
Feb 27, 2026
Merged

chore: Don't unconditionally check tools/gn formatting#182973
auto-submit[bot] merged 2 commits intoflutter:masterfrom
harryterkelsen:align-python-format-gn

Conversation

@harryterkelsen
Copy link
Contributor

Previously, the 'gn' script was hardcoded to be checked on every run. By moving it into the 'getFileList' call, it now correctly respects git diff and the '--all-files' flag, ensuring it is only formatted when actually modified.

This prevents me from hitting the "YAPF is not supported on Python 3.14" issue on every "git push".

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Previously, the 'gn' tool was hardcoded to be checked on every run. By
moving it into the 'getFileList' call, it now correctly respects git
diff and the '--all-files' flag, ensuring it is only formatted when
actually modified.
@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

@github-actions github-actions bot added the engine flutter/engine related. See also e: labels. label Feb 26, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request modifies the Python format checker to conditionally check the tools/gn script. Previously, this script was checked unconditionally on every run. The change moves the script's path into the getFileList call, so that it is only checked if it has been modified or if all files are being checked. This is achieved by replacing a hardcoded absolute path with a relative path pattern passed to getFileList.

@jtmcdole jtmcdole changed the title (chore) Don't unconditionally check tools/gn formatting chore: Don't unconditionally check tools/gn formatting Feb 26, 2026
@jtmcdole jtmcdole requested a review from zanderso February 26, 2026 22:55
@jtmcdole
Copy link
Member

@zanderso - you did this change 4 years ago in flutter/engine#33812 - any history we should be aware of?

@harryterkelsen
Copy link
Contributor Author

To my eyes, @zanderso 's PR just wants to make sure we also format tools/gn since it's missed by the getFileList call since it doesn't end in .py. However, since it is added to the files list regardless of if it was changed, then it will always be formatted. A quick scan of the rest of the formatting script shows that tools/gn is the only file that is unconditionally checked like this.

@zanderso
Copy link
Member

This looks like a good change to me.

There are tests for this script in https://github.com/flutter/flutter/blob/master/engine/src/flutter/ci/test/format_test.dart. Is it possible to add a test there for this change?

@harryterkelsen
Copy link
Contributor Author

I added a test which checks that we still format tools/gn if it is changed. PTAL @zanderso @jtmcdole

Copy link
Member

@zanderso zanderso left a comment

Choose a reason for hiding this comment

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

Thanks!

@jtmcdole jtmcdole added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 27, 2026
@auto-submit auto-submit bot added this pull request to the merge queue Feb 27, 2026
Merged via the queue into flutter:master with commit 68a7200 Feb 27, 2026
183 checks passed
@flutter-dashboard flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Feb 27, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 28, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 28, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 1, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 1, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 2, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 2, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 2, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 2, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 2, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 2, 2026
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Mar 2, 2026
Roll Flutter from 1141b2bdce66 to 46fb7210422d (38 revisions)

flutter/flutter@1141b2b...46fb721

2026-03-02 [email protected] [rules] Fix a few issues in the full-length rules file (flutter/flutter#182725)
2026-03-02 [email protected] Roll Dart SDK from 8063f5f5ac60 to e86dbe9aa742 (1 revision) (flutter/flutter#183120)
2026-03-02 [email protected] [web] Roll Chrome to 145 (flutter/flutter#182860)
2026-03-02 [email protected] Roll Skia from 61c0e71760f5 to e180358b7a7a (1 revision) (flutter/flutter#183118)
2026-03-02 [email protected] Roll Packages from a27d7c5 to faa4e22 (4 revisions) (flutter/flutter#183117)
2026-03-02 [email protected] Add information to issue triage page (flutter/flutter#182145)
2026-03-02 [email protected] Roll Skia from cc8ce92481f2 to 61c0e71760f5 (2 revisions) (flutter/flutter#183103)
2026-03-02 [email protected] Roll Skia from 4cf3cd27b620 to cc8ce92481f2 (1 revision) (flutter/flutter#183100)
2026-03-02 [email protected] Roll Fuchsia Linux SDK from zN2ZV9QD0LD8acUFF... to 0dCDM2oORHwDf_pyb... (flutter/flutter#183101)
2026-03-01 [email protected] Update fl_texture_gl.h (flutter/flutter#182999)
2026-03-01 [email protected] Roll Skia from be1362b5ca4e to 4cf3cd27b620 (1 revision) (flutter/flutter#183096)
2026-03-01 [email protected] Roll Skia from b9210eb7005f to be1362b5ca4e (1 revision) (flutter/flutter#183092)
2026-03-01 [email protected] Timeout when waiting for the correct sized frame from Flutter. (flutter/flutter#182971)
2026-03-01 [email protected] Roll Skia from 28172a4e03af to b9210eb7005f (1 revision) (flutter/flutter#183088)
2026-03-01 [email protected] Roll Fuchsia Linux SDK from D7IYacJUCpvc_1iU_... to zN2ZV9QD0LD8acUFF... (flutter/flutter#183076)
2026-02-28 [email protected] Roll Dart SDK from cdf45eaf995e to 8063f5f5ac60 (1 revision) (flutter/flutter#183064)
2026-02-28 [email protected] Roll Dart SDK from 54451fcdbcf9 to cdf45eaf995e (1 revision) (flutter/flutter#183057)
2026-02-28 [email protected] Roll Skia from c8bcc27f5319 to 28172a4e03af (3 revisions) (flutter/flutter#183056)
2026-02-28 [email protected] Roll Dart SDK from 148d91b8a603 to 54451fcdbcf9 (2 revisions) (flutter/flutter#183051)
2026-02-28 [email protected] [A11y] in calendar date picker, remove SemanticsService.sendAnnouncement usage for android.  (flutter/flutter#182918)
2026-02-28 [email protected] Add desktop review teams (flutter/flutter#182972)
2026-02-28 [email protected] [framework] Fix Text.semanticsIdentifier being absorbed by ancestor nodes (flutter/flutter#181795)
2026-02-28 [email protected] Roll Skia from b150186d3e23 to c8bcc27f5319 (5 revisions) (flutter/flutter#183032)
2026-02-28 [email protected] [Impeller] For Android hardware buffers on Vulkan, use an alpha value of 1 if the buffer format always has opaque alpha (flutter/flutter#182974)
2026-02-27 [email protected] Adds float32 output to `Image.toByteData()` in float32 Image (flutter/flutter#182847)
2026-02-27 [email protected] Roll Dart SDK from 1cdb7dfd913e to 148d91b8a603 (1 revision) (flutter/flutter#183025)
2026-02-27 [email protected] Roll Fuchsia Linux SDK from G1GwOdVt5bM7GjMSY... to D7IYacJUCpvc_1iU_... (flutter/flutter#183021)
2026-02-27 [email protected] When impellerc fails with a long shader compilation error, truncate it and output to a file (flutter/flutter#182786)
2026-02-27 [email protected] Add missing mutation-safe delegate iteration and use idomatic syntax (flutter/flutter#183018)
2026-02-27 [email protected] Exclude arm64 if any dependencies do and print warning when using Xcode 26 (flutter/flutter#182913)
2026-02-27 [email protected] Ignore unawaited_futures lint in dev/automated_tests (flutter/flutter#182922)
2026-02-27 [email protected] licenses_cpp: pre-land changes for perfetto update (flutter/flutter#182965)
2026-02-27 [email protected] Re-add extended attribute removed by SwiftPM (flutter/flutter#183011)
2026-02-27 [email protected] Fixes future warning for `await`ing `Future` returns in `async` bodies inside `try` blocks (flutter/flutter#182301)
2026-02-27 [email protected] Roll Skia from ed220c490eea to b150186d3e23 (2 revisions) (flutter/flutter#183014)
2026-02-27 [email protected] Fix issue where web embedder is synthesizing key up events too eagerly (flutter/flutter#180692)
2026-02-27 [email protected] chore: Don't unconditionally check tools/gn formatting (flutter/flutter#182973)
2026-02-27 [email protected] Roll Packages from e1d0169 to a27d7c5 (8 revisions) (flutter/flutter#183009)

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
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose
...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

engine flutter/engine related. See also e: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants