[CP-beta]Disable multi-pack-index when calling flutter from Xcode#185100
Conversation
) Flutter iOS and macOS apps call `flutter assemble` from within Xcode. However, Xcode uses it's own version of git instead of the user's. This causes an multi-pack-index incompatibility. This PR disables the multi-pack-index config when running `git ls-tree` to workaround this issue. Fixes flutter#184376. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. If this change needs to override an active code freeze, provide a comment explaining why. The code freeze workflow can be overridden by code reviewers. See pinned issues for any active code freezes with guidance. **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). 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. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [AI contribution guidelines]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
|
@vashworth please fill out the PR description above, afterwards the release team will review this request. |
|
This pull request was opened from and to a release candidate branch. This should only be done as part of the official Flutter release process. If you are attempting to make a regular contribution to the Flutter project, please close this PR and follow the instructions at Tree Hygiene for detailed instructions on contributing to Flutter. Reviewers: Use caution before merging pull requests to release branches. Ensure the proper procedure has been followed. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request implements a workaround for Xcode's git multi-pack-index incompatibility in bin/internal/content_aware_hash.sh by disabling the feature when Apple Git is detected. Reviewers suggested optimizing the detection logic by checking $OSTYPE first to avoid unnecessary process forks on non-macOS platforms and applying the git configuration consistently to all commands in the pipeline.
| # Workaround for Xcode's git multi-pack-index incompatibility. | ||
| # https://github.com/flutter/flutter/issues/184376 | ||
| GIT_OPTS=() | ||
| if [[ "$(git --version)" == *"Apple Git"* ]]; then |
There was a problem hiding this comment.
Calling git --version on every invocation of this script adds a process fork to the startup path of every flutter command. Since this workaround is specific to Apple Git (macOS), consider checking the operating system first using the $OSTYPE variable to avoid this overhead on other platforms.
| if [[ "$(git --version)" == *"Apple Git"* ]]; then | |
| if [[ "$OSTYPE" == "darwin"* ]] && [[ "$(git --version)" == *"Apple Git"* ]]; then |
| if [[ "$(git --version)" == *"Apple Git"* ]]; then | ||
| GIT_OPTS=(-c core.multiPackIndex=false) | ||
| fi | ||
| git "${GIT_OPTS[@]}" -C "$FLUTTER_ROOT" ls-tree "$BASEREF" -- "${TRACKEDFILES[@]}" | git hash-object --stdin |
There was a problem hiding this comment.
The workaround for multi-pack-index should also be applied to the second git command in the pipeline. If the environment or the specific Git version has issues with this feature, it could affect any Git invocation that initializes the repository context or reads the configuration, not just ls-tree. Applying it consistently ensures the fix is robust.
| git "${GIT_OPTS[@]}" -C "$FLUTTER_ROOT" ls-tree "$BASEREF" -- "${TRACKEDFILES[@]}" | git hash-object --stdin | |
| git "${GIT_OPTS[@]}" -C "$FLUTTER_ROOT" ls-tree "$BASEREF" -- "${TRACKEDFILES[@]}" | git "${GIT_OPTS[@]}" hash-object --stdin |
References
- The style guide emphasizes doing things right when they are written. Applying the workaround consistently to all git commands in the pipeline ensures the fix is robust. (link)
There was a problem hiding this comment.
I don't think this is true and its something with ls-files that was failing.
…36fc05d58abdad05314ec93c
eyebrowsoffire
added
CICD
auto-submit
Bot
merged commit 92b3bf7
into
flutter:flutter-3.44-candidate.0
4 participants
This pull request is created by automatic cherry pick workflow
Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request.
Issue Link:
What is the link to the issue this cherry-pick is addressing?
#184376
Impact Description:
What is the impact (ex. visual jank on Samsung phones, app crash, cannot ship an iOS app)?
Does it impact development (ex. flutter doctor crashes when Android Studio is installed),
or the shipping of production apps (the app crashes on launch).
This information is for domain experts and release engineers to understand the consequences of saying yes or no to the cherry pick.
Xcode's version of git may conflict with user's version of git when determining the flutter content hash on macOS due to multi-pack-index incompatibility.
Changelog Description:
Explain this cherry pick:
See best practices for examples.
< Replace with changelog description here >
[flutter/184376] When building an iOS or macOS app, the build may fail due to git multi-pack-index error.
Workaround:
Is there a workaround for this issue?
Disable multi-pack via env variable: #184376 (comment)
Risk:
What is the risk level of this cherry-pick?
Test Coverage:
Are you confident that your fix is well-tested by automated tests?
Validation Steps:
What are the steps to validate that this fix works?
Run
flutter build ioson computer withgitversion that contains this commit: git/git@105a22cf69