How can I copy a framework after building in an Xcode script?

To copy a framework after building in an Xcode script, you can use a Run Script build phase. Here's a breakdown of the process and a sample script:

1. Add a New Run Script Build Phase:

- Open your Xcode project.

- Select your project in the Project Navigator.

- Choose the target where you build the framework from.

- Go to "Build Phases".

- Click the "+" button at the top left and select "New Run Script Phase".

- Drag the newly created run script phase just below the `Link Binary with Libraries` Phase. This ensures that the build product is available during script execution.

2. Write the Script:

- In the Run Script section, paste the following script:

#!/bin/sh
# Get the built framework's path
FRAMEWORK_PATH="$BUILT_PRODUCTS_DIR/$PRODUCT_NAME.framework"

# Set your destination directory path
DESTINATION_DIR="$PROJECT_DIR/Frameworks"

# Create the destination directory if it does not exist
mkdir -p "$DESTINATION_DIR"

# Copy the framework
cp -R "$FRAMEWORK_PATH" "$DESTINATION_DIR"

# Optional: Output a message to the build log
echo "Copied framework to: $DESTINATION_DIR"

3. Explanation of the Script:

- #!/bin/sh: Specifies that the script should be executed with `sh`.

- FRAMEWORK_PATH="$BUILT_PRODUCTS_DIR/$PRODUCT_NAME.framework": Gets the path of the built framework. Xcode provides the `BUILT_PRODUCTS_DIR` and `PRODUCT_NAME` variables automatically.

- DESTINATION_DIR="$PROJECT_DIR/Frameworks": Sets the destination directory where the framework will be copied to. Adjust this path to your needs. In this case we created a new folder called `Frameworks` inside project folder

- mkdir -p "$DESTINATION_DIR": Ensures the destination directory is created if it doesn't exist, the `-p` flag means creating parent folders if necessary.

- cp -R "$FRAMEWORK_PATH" "$DESTINATION_DIR": Copies the framework to the destination directory using the `cp` command, the `-R` flag means copying recursively.

- echo "Copied framework to: $DESTINATION_DIR": This optional part of the script displays a message in Xcode's build logs, showing where the framework was copied.

4. Important Considerations

- Adjust Paths: Make sure to modify the DESTINATION_DIR to match your project's structure and needs. You can use Xcode build variables like $PROJECT_DIR, $TARGET_BUILD_DIR, etc., to configure the location dynamically.

- Framework Structure: The cp -R command is ideal for frameworks as it preserves the structure. If you have specific file handling needs within the framework, you may need a more complex copy operation.

- Code Signing: If your framework is code signed, ensure your copy operation preserves the signing information. The cp -R command generally handles this correctly, but always test.

- Dynamic Frameworks: When copying dynamic frameworks for usage in application bundles, make sure the path of the copied frameworks are correctly set in the target's "Frameworks, Libraries, and Embedded Content" settings. To set this correctly, click on your project target, go to "General" tab and under the "Frameworks, Libraries, and Embedded Content" make sure the embed options is set correctly (Embed & Sign).

- Debugging: Use the `echo` commands in the script for debugging if the copy fails or encounters issues during the build process.

By following these steps, you can successfully set up a post-build script in Xcode to copy your built framework to a desired location automatically after each build. This ensures that your framework is available where needed without manual copy actions.

Learn more about this