[Draft] GPT Driver Automation #1499
Conversation
|
Summary By MatterAI
🔄 What ChangedA new GitHub Actions workflow, The workflow executes a series of sequential steps:
🔍 Impact of the ChangeThis new workflow significantly enhances the CI/CD pipeline by automating a critical part of the iOS release process. By automatically building the SDK, integrating it into a sample app, and running tests via the GPTDriver service upon every push to a release branch, it ensures early detection of integration issues and build failures. This automation reduces manual overhead, improves the reliability and consistency of release builds, and accelerates the feedback loop for developers, ultimately contributing to a more robust and efficient release cycle. 📁 Total Files Changed1 file changed. 🧪 Test AddedThis Pull Request introduces a new CI/CD workflow that serves as an automated testing and build verification mechanism. The workflow's steps collectively act as a comprehensive test setup:
🔒Security VulnerabilitiesNo direct security vulnerabilities were detected in the provided workflow configuration. The use of GitHub Secrets ( Tip Quality Recommendations
Sequence DiagramsequenceDiagram
participant GitHub as GitHub Push Event
participant Workflow as iOS Release Build and GPTDriver Tests Workflow
participant Extractor as Extract version from branch name
participant CheckoutSDK as Checkout BranchMetrics/ios-branch-deep-linking-attribution
participant BuildSDK as Build Branch SDK Framework
participant CheckoutApp as Checkout BranchMetrics/BranchLinkSimulator
participant CopySDK as Copy generated SDK Framework
participant BuildApp as Build iOS App with local SDK
participant EchoApp as Echo .app bundle location
participant UploadArtifact as Upload Build Artifacts
participant GPTDriver as Run GPTDriver tests
GitHub->>Workflow: Push to 'Release-*' branch
Workflow->>Extractor: Trigger
Extractor->>Extractor: Get github.ref (e.g., refs/heads/Release-0.0.0)
Extractor-->>Workflow: Set env.VERSION_STRING (e.g., 0.0.0)
Extractor-->>Workflow: Set env.VERSION_CODE_INT (e.g., 102003)
Workflow->>CheckoutSDK: uses: actions/checkout@v4 (repository: BranchMetrics/ios-branch-deep-linking-attribution, ref: ${{ github.ref }}, path: ./branch-ios-sdk-repo)
CheckoutSDK-->>Workflow: SDK repository checked out
Workflow->>BuildSDK: xcodebuild build -project Branch-SDK/Branch-SDK.xcodeproj -scheme BranchSDK -configuration Debug -sdk iphonesimulator BUILD_DIR="${{ github.workspace }}/branch-ios-sdk-repo/build" SKIP_INSTALL=NO (working-directory: ./branch-ios-sdk-repo)
BuildSDK-->>Workflow: BranchSDK.framework built
Workflow->>CheckoutApp: uses: actions/checkout@v4 (repository: BranchMetrics/BranchLinkSimulator, ref: gptdriver/linkingTests, path: ./ios-app-repo)
CheckoutApp-->>Workflow: App repository checked out
Workflow->>CopySDK: mkdir -p ./ios-app-repo/Frameworks; cp -R ./branch-ios-sdk-repo/build/Debug-iphonesimulator/BranchSDK.framework ./ios-app-repo/Frameworks/ (working-directory: ${{ github.workspace }})
CopySDK-->>Workflow: SDK Framework copied to App
Workflow->>BuildApp: xcodebuild build -project BranchLinkSimulator.xcodeproj -scheme BranchLinkSimulator -configuration Debug -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone 15' MARKETING_VERSION=${{ env.VERSION_STRING }} CURRENT_PROJECT_VERSION=${{ env.VERSION_CODE_INT }} (working-directory: ./ios-app-repo)
BuildApp-->>Workflow: BranchLinkSimulator.app built
Workflow->>EchoApp: echo "Generated .app bundle location: ./ios-app-repo/build/Debug-iphonesimulator/BranchLinkSimulator.app"
EchoApp-->>Workflow: App bundle path echoed
Workflow->>UploadArtifact: uses: actions/upload-artifact@v4 (name: BranchLinkSimulator-iOS-Debug-Build, path: ./ios-app-repo/build/Debug-iphonesimulator/BranchLinkSimulator.app)
UploadArtifact-->>Workflow: App bundle uploaded as artifact
Workflow->>GPTDriver: chmod +x ./branch-ios-sdk-repo/.github/gptdriverrunscript.sh; bash ./branch-ios-sdk-repo/.github/gptdriverrunscript.sh ./ios-app-repo/build/Debug-iphonesimulator/BranchLinkSimulator.app ios (env: API_ORG_KEY, API_KEY, TEST_TAGS)
GPTDriver-->>Workflow: GPTDriver tests initiated/completed
|
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use Matter AICommand List
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
|
||
| echo "Extracted versionName: $VERSION" | ||
| echo "VERSION_STRING=$VERSION" >> $GITHUB_ENV | ||
|
|
||
| # Convert semantic version to an integer for CFBundleVersion (versionCode equivalent) | ||
| # Example: 1.2.3 -> 102003 (assuming max 2 digits for minor/patch) | ||
| # This should be adjusted based on the maximum expected values for major/minor/patch | ||
| MAJOR=$(echo "$VERSION" | cut -d. -f1) | ||
| MINOR=$(echo "$VERSION" | cut -d. -f2) | ||
| PATCH=$(echo "$VERSION" | cut -d. -f3) | ||
|
|
||
| # Calculate versionCode (CFBundleVersion) - ensure this fits in a 32-bit integer | ||
| # Standard Android-like conversion: Major * 10000 + Minor * 100 + Patch | ||
| # This provides sufficient uniqueness for most common versioning schemes. | ||
| VERSION_CODE_INT=$(( MAJOR * 10000 + MINOR * 100 + PATCH )) | ||
| echo "Calculated versionCode: $VERSION_CODE_INT" | ||
| echo "VERSION_CODE_INT=$VERSION_CODE_INT" >> $GITHUB_ENV | ||
|
|
||
|
|
||
| # --- Step 2: Checkout the iOS Branch SDK repository --- | ||
| - name: Checkout BranchMetrics/ios-branch-deep-linking-attribution (SDK) | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: BranchMetrics/ios-branch-deep-linking-attribution | ||
| ref: ${{ github.ref }} # Use the same branch that triggered the workflow | ||
| path: ./branch-ios-sdk-repo # Checkout into a subdirectory | ||
|
|
||
| # --- Step 3: Build the iOS Branch SDK Framework --- | ||
| - name: Build Branch SDK Framework | ||
| run: | | ||
| # Build for simulator. Adjust scheme if necessary. | ||
| # The output framework will be in build/Debug-iphonesimulator/BranchSDK.framework | ||
| xcodebuild build -project Branch-SDK/Branch-SDK.xcodeproj \ | ||
| -scheme BranchSDK \ | ||
| -configuration Debug \ | ||
| -sdk iphonesimulator \ | ||
| BUILD_DIR="${{ github.workspace }}/branch-ios-sdk-repo/build" \ | ||
| SKIP_INSTALL=NO | ||
| working-directory: ./branch-ios-sdk-repo # Run xcodebuild from the SDK's checkout directory | ||
|
|
||
| # --- Step 4: Checkout the iOS Branch Link Simulator App repository --- | ||
| - name: Checkout BranchMetrics/BranchLinkSimulator (App) | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: BranchMetrics/BranchLinkSimulator | ||
| ref: gptdriver/linkingTests # Checkout the specific app branch | ||
| path: ./ios-app-repo # Checkout into another subdirectory | ||
|
|
||
| # --- Step 5: Copy the generated SDK Framework to the App's project --- | ||
| - name: Copy generated SDK Framework to App's libs directory | ||
| run: | | ||
| # Create a 'Frameworks' directory within the app repo for the local SDK | ||
| mkdir -p ./ios-app-repo/Frameworks | ||
| # Copy the built framework | ||
| cp -R ./branch-ios-sdk-repo/build/Debug-iphonesimulator/BranchSDK.framework ./ios-app-repo/Frameworks/ | ||
| working-directory: ${{ github.workspace }} # Run from the root of the GITHUB_WORKSPACE | ||
|
|
||
| # --- Step 6: Build the iOS Branch Link Simulator App using the local SDK Framework --- | ||
| - name: Build iOS App with local SDK | ||
| run: | | ||
| # Build the app. Adjust project/workspace, scheme, and destination if necessary. | ||
| # We're passing MARKETING_VERSION (versionName) and CURRENT_PROJECT_VERSION (versionCode) | ||
| xcodebuild build -project BranchLinkSimulator.xcodeproj \ | ||
| -scheme BranchLinkSimulator \ | ||
| -configuration Debug \ | ||
| -sdk iphonesimulator \ | ||
| -destination 'platform=iOS Simulator,name=iPhone 15' \ | ||
| MARKETING_VERSION=${{ env.VERSION_STRING }} \ | ||
| CURRENT_PROJECT_VERSION=${{ env.VERSION_CODE_INT }} \ | ||
| # Adjust Framework Search Paths if your Xcode project doesn't automatically find it | ||
| # For example, if you need to point directly to the copied framework: | ||
| # FRAMEWORK_SEARCH_PATHS="$(SRCROOT)/Frameworks" | ||
| working-directory: ./ios-app-repo # Run xcodebuild from the App's checkout directory | ||
|
|
||
| # --- Step 7: Echo the location of the generated .app bundle --- | ||
| - name: Echo .app bundle location | ||
| run: | | ||
| APP_PATH="./ios-app-repo/build/Debug-iphonesimulator/BranchLinkSimulator.app" | ||
| echo "Generated .app bundle location: $APP_PATH" | ||
| # You can also use 'find' to be more dynamic if the name might change | ||
| # find ./ios-app-repo/build -name "*.app" | ||
|
|
||
| # --- Step 8: Upload Build Artifacts --- | ||
| - name: Upload Build Artifacts | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: BranchLinkSimulator-iOS-Debug-Build | ||
| path: ./ios-app-repo/build/Debug-iphonesimulator/BranchLinkSimulator.app | ||
|
|
||
| # --- Step 9: Upload and run tests on GPTDriver service. --- | ||
| - name: Run GPTDriver tests | ||
| run: | | ||
| # Ensure the script is executable | ||
| chmod +x ./branch-ios-sdk-repo/.github/gptdriverrunscript.sh | ||
| # Execute the script, passing the .app path and platform | ||
| bash ./branch-ios-sdk-repo/.github/gptdriverrunscript.sh ./ios-app-repo/build/Debug-iphonesimulator/BranchLinkSimulator.app ios | ||
| env: | ||
| API_ORG_KEY: ${{ secrets.MOBILEBOOST_API_ORG_KEY }} | ||
| API_KEY: ${{ secrets.MOBILEBOOST_API_ORG_KEY }} # As per vendor design | ||
| TEST_TAGS: Release |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI 2 months ago
To fix the issue, add a permissions block at the root level of the workflow file. This block will explicitly define the permissions required for the workflow, ensuring that the GITHUB_TOKEN has the least privileges necessary. Based on the workflow's operations, the contents: read permission is sufficient, as the workflow only needs to read repository contents (e.g., for checkout operations). No write permissions are required.
The permissions block should be added immediately after the name field at the top of the file.
| @@ -1,2 +1,4 @@ | ||
| name: iOS Release Build and GPTDriver Tests | ||
| permissions: | ||
| contents: read | ||
|
|
Reference
SDK-XXXX -- <TITLE>.
Summary
Motivation
Type Of Change
Testing Instructions
cc @BranchMetrics/saas-sdk-devs for visibility.