Skip to content

Commit

Permalink
[iOS] Rename create_{full_,}ios_framework.py (flutter#54493)
Browse files Browse the repository at this point in the history
This renames the iOS framework creation script for consistency with the analogous macOS script.

Previously, we had two iOS framework creation scripts:
* create_ios_framework.py
* create_full_ios_framework.py

The former was unused and was deleted in flutter#54227. The addition of "full" is no longer necessary to differentiate the two.

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
  • Loading branch information
cbracken authored Aug 10, 2024
1 parent 98e1c7d commit 4878a32
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 14 deletions.
2 changes: 1 addition & 1 deletion build/archives/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ generated_file("artifacts_entitlement_config") {
# gen_snapshot_x64 are used in its place).
#
# Target-specific iOS artifacts.zip are produced in:
# //flutter/sky/tools/create_full_ios_framework.py
# //flutter/sky/tools/create_ios_framework.py
#
# Target-specific Android archives are produced in:
# //flutter/shell/platform/android:gen_snapshot
Expand Down
12 changes: 8 additions & 4 deletions ci/builders/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ be relative to the checkout directory.
"--simulator-arm64-out-dir",
"out/ios_debug_sim_arm64"
],
"script": "flutter/sky/tools/create_full_ios_framework.py",
"script": "flutter/sky/tools/create_ios_framework.py",
"language": "python3"
}
```
Expand Down Expand Up @@ -657,7 +657,11 @@ copied verbatim from the executions details of the build.
The following example will run the generator to create the ios artifacts:

```bash
python3 flutter/sky/tools/create_full_ios_framework.py --dst out/release \
--arm64-out-dir out/ios_release --simulator-x64-out-dir out/ios_debug_sim \
--simulator-arm64-out-dir out/ios_debug_sim_arm64 --dsym --strip
python3 flutter/sky/tools/create_ios_framework.py \
--dst out/release \
--arm64-out-dir out/ios_release \
--simulator-x64-out-dir out/ios_debug_sim \
--simulator-arm64-out-dir out/ios_debug_sim_arm64 \
--dsym \
--strip
```
6 changes: 3 additions & 3 deletions ci/builders/mac_ios_engine.json
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@
"--simulator-arm64-out-dir",
"out/ci/ios_debug_sim_arm64"
],
"script": "flutter/sky/tools/create_full_ios_framework.py",
"script": "flutter/sky/tools/create_ios_framework.py",
"language": "python3"
},
{
Expand All @@ -494,7 +494,7 @@
"--simulator-arm64-out-dir",
"out/ci/ios_debug_sim_arm64"
],
"script": "flutter/sky/tools/create_full_ios_framework.py",
"script": "flutter/sky/tools/create_ios_framework.py",
"language": "python3"
},
{
Expand All @@ -511,7 +511,7 @@
"--dsym",
"--strip"
],
"script": "flutter/sky/tools/create_full_ios_framework.py",
"script": "flutter/sky/tools/create_ios_framework.py",
"language": "python3"
},
{
Expand Down
2 changes: 1 addition & 1 deletion ci/licenses_golden/excluded_files
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,7 @@
../../../flutter/sky/packages/sky_engine/lib/_embedder.yaml
../../../flutter/sky/packages/sky_engine/pubspec.yaml
../../../flutter/sky/tools/create_embedder_framework.py
../../../flutter/sky/tools/create_full_ios_framework.py
../../../flutter/sky/tools/create_ios_framework.py
../../../flutter/sky/tools/create_macos_binary.py
../../../flutter/sky/tools/create_macos_framework.py
../../../flutter/sky/tools/create_macos_gen_snapshots.py
Expand Down
10 changes: 5 additions & 5 deletions docs/release/Code-signing-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,15 +148,15 @@ You can reference the
[mac_host_engine.json](https://github.com/flutter/engine/blob/main/ci/builders/mac_host_engine.json)).
The generator script related to iOS is located at
`sky/tools/create_full_ios_framework.py`, and generator script related to
`sky/tools/create_ios_framework.py`, and generator script related to
macOS is located at `sky/tools/create_macos_framework.py`.
2. Add / Update the variables ending with `with_entitlements` /
`without_entitlements` suffix from the generator script you found in step
one.
As an example, you can find variables `ios_file_without_entitlements` and
`ios_file_with_entitlements` in sky/tools/create_full_ios_framework.py; and
`ios_file_with_entitlements` in sky/tools/create_ios_framework.py; and
find variables `filepath_without_entitlements` and
`filepath_with_entitlements` in sky/tools/create_macos_framework.py
Expand All @@ -176,7 +176,7 @@ that exist in a zip bundle called `ios/artifacts.zip`.
1. Following step 1, in
[mac_ios_engine.json](https://github.com/flutter/engine/blob/main/ci/builders/mac_ios_engine.json),
it builds the artifact with the
`flutter/sky/tools/create_full_ios_framework.py` script.
`flutter/sky/tools/create_ios_framework.py` script.
2. Following step 2, since
`Flutter.xcframework/ios-arm64/Flutter.framework/Flutter` shouldn't be code
Expand All @@ -185,12 +185,12 @@ that exist in a zip bundle called `ios/artifacts.zip`.
`ios_file_without_entitlements` variable.
You can reference the generator script
[create_full_ios_framework.py](https://github.com/flutter/engine/blob/main/sky/tools/create_full_ios_framework.py).
[create_ios_framework.py](https://github.com/flutter/engine/blob/main/sky/tools/create_ios_framework.py).
## Code signing artifacts other than flutter engine binaries
The code signing functionality is implemented as [a recipe module in flutter recipes](https://cs.opensource.google/flutter/recipes/+/master:recipe_modules/signing/api.py). Therefore it can also be used to
code sign arbitrary flutter artifacts built through recipe, for example, flutter iOS usb dependencies.
To code sign, after the artifacts are built, pass the file paths into
the code signing recipe module and invoke the function. An example is [how engine V2 invokes the code signing recipe module](https://cs.opensource.google/flutter/recipes/+/master:recipes/engine_v2/engine_v2.py;l=197-212).
the code signing recipe module and invoke the function. An example is [how engine V2 invokes the code signing recipe module](https://cs.opensource.google/flutter/recipes/+/master:recipes/engine_v2/engine_v2.py;l=197-212).
File renamed without changes.

0 comments on commit 4878a32

Please sign in to comment.