Skip to content

Add and update workflows for release and non-release SDK sample apps #1

Add and update workflows for release and non-release SDK sample apps

Add and update workflows for release and non-release SDK sample apps #1

name: Reusable build sample apps workflow

Check failure on line 1 in .github/workflows/reusable-build-sample-apps.yml

View workflow run for this annotation

GitHub Actions / .github/workflows/reusable-build-sample-apps.yml

Invalid workflow file

`build-android-sample-apps` is not a valid event name
on:
workflow_call:
inputs:
use_latest_sdk_version:
description: "Whether this workflow should build sample apps with latest SDK version or source code"
type: boolean
required: false
default: false
build-android-sample-apps:
strategy:
fail-fast: false # if one sample app fails to build, let the other sample apps continue to build and not cancel them.
matrix: # Use a matrix allowing us to build multiple apps in parallel. Just add an entry to the matrix and it will build!
sample-app:
# List all sample apps you want to have compiled.
# List item is name of directory inside of "apps" directory for the corresponding app to compile.
- name: "amiapp_flutter"
cio-workspace-name: "Mobile: Flutter"
defaults:
run:
working-directory: apps/${{ matrix.sample-app.name }}
runs-on: ubuntu-latest
name: Building Android sample app ${{ matrix.sample-app.name }}
steps:
- name: Check out code
uses: actions/checkout@v4
with:
fetch-depth: 0 # Workaround for bug https://github.com/actions/checkout/issues/1471
- name: Get latest SDK version
if: ${{ inputs.use_latest_sdk_version == true }}
id: latest-sdk-version-step
run: |
latest_tag=$(git describe --tags --abbrev=0)
echo "LATEST_TAG=$latest_tag" >> "$GITHUB_OUTPUT"
- name: Set Default Firebase Distribution Groups
shell: bash
env:
# Distribution group constants
ALL_BUILDS_GROUP: all-builds
FEATURE_BUILDS_GROUP: feature-branch
NEXT_BUILDS_GROUP: next
PUBLIC_BUILDS_GROUP: public
# Input variables
CURRENT_BRANCH: ${{ github.ref }}
run: |
# Initialize with the default distribution group
distribution_groups=("$ALL_BUILDS_GROUP")
# Append distribution groups based on branch and context
[[ "$CURRENT_BRANCH" == "refs/heads/feature/"* ]] && distribution_groups+=("$FEATURE_BUILDS_GROUP")
[[ "$CURRENT_BRANCH" == "refs/heads/main" ]] && distribution_groups+=("$NEXT_BUILDS_GROUP")
[[ "$USE_LATEST_SDK_VERSION" == "true" ]] && distribution_groups+=("$PUBLIC_BUILDS_GROUP")
# Export the groups as an environment variable
echo "firebase_distribution_groups=$(IFS=','; echo "${distribution_groups[*]}")" >> $GITHUB_ENV
# Install CLI tools, Ruby, and Ruby dependencies for Fastlane
- name: Install CLI tools used in CI script
shell: bash
run: |
brew install sd # used in CI script as an easier to use sed CLI. Replaces text in files.
- name: Install Ruby
uses: ruby/setup-ruby@v1
with:
bundler-cache: true # cache tools to make builds faster in future
working-directory: apps/${{ matrix.sample-app.name }}
# Update version numbers and workspace credentials before building the app
- name: Generate New Version
uses: maierj/fastlane-action@v3.1.0
with:
subdirectory: apps/${{ matrix.sample-app.name }}
lane: "generate_new_version"
options: '{"branch_name":"${{ github.ref_name }}", "pull_request_number":"${{ github.event.pull_request.number }}"}'
- name: Update Flutter SDK Version
uses: maierj/fastlane-action@v3.1.0
with:
subdirectory: apps/${{ matrix.sample-app.name }}
lane: "update_flutter_sdk_version"
env:
SDK_VERSION_NAME: ${{ env.SDK_VERSION_NAME }}
APP_VERSION_NAME: ${{ env.APP_VERSION_NAME }}
APP_VERSION_CODE: ${{ env.APP_VERSION_CODE }}
- name: Update Sample App Version
uses: maierj/fastlane-action@v3.1.0
with:
subdirectory: apps/${{ matrix.sample-app.name }}
lane: "update_flutter_app_version"
options: ${{ inputs.use_latest_sdk_version == true && format('{{"version_name":"{0}"}}', steps.latest-sdk-version-step.outputs.LATEST_TAG) || '' }}
env:
SDK_VERSION_NAME: ${{ env.SDK_VERSION_NAME }}
APP_VERSION_NAME: ${{ env.APP_VERSION_NAME }}
APP_VERSION_CODE: ${{ env.APP_VERSION_CODE }}
- name: Setup workspace credentials in flutter environment files
env:
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
COMMIT_HASH: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
run: |
env_file=".env"
touch "$env_file"
echo "BUILD_TIMESTAMP=$(date +%s)" >> "$env_file"
echo "CDP_API_KEY=${{ secrets[format('CUSTOMERIO_{0}_WORKSPACE_CDP_API_KEY', matrix.sample-app.name)] }}" >> "$env_file"
echo "SITE_ID=${{ secrets[format('CUSTOMERIO_{0}_WORKSPACE_SITE_ID', matrix.sample-app.name)] }}" >> "$env_file"
echo "WORKSPACE_NAME=${{ matrix.sample-app.cio-workspace-name }}" >> "$env_file"
echo "BRANCH_NAME=$BRANCH_NAME" >> "$env_file"
echo "COMMIT_HASH=${COMMIT_HASH:0:7}" >> "$env_file"
echo "COMMITS_AHEAD_COUNT=$(git rev-list $(git describe --tags --abbrev=0)..HEAD --count)" >> "$env_file"
if [ "${{ inputs.use_latest_sdk_version }}" == "true" ]; then
echo "SDK_VERSION=${{ steps.latest-sdk-version-step.outputs.LATEST_TAG }}" >> "$env_file"
fi
# Make sure to fetch dependencies only after updating the version numbers and workspace credentials
- name: Setup flutter environment and install dependencies
uses: ./.github/actions/setup-flutter
- name: Use SDK release version for sample app (if needed)
working-directory: apps/amiapp_flutter
run: |
dart run scripts/update_sample_app_sdk_version.dart
cat pubspec.lock
- name: Install flutter dependencies for sample app
run: flutter pub get
- name: Setup Android environment for sample app
uses: customerio/customerio-android/.github/actions/setup-android@main
- name: Build and upload Android app via Fastlane
id: android_build
uses: maierj/fastlane-action@v3.1.0
with:
subdirectory: apps/${{ matrix.sample-app.name }}
lane: 'android build'
options: '{"distribution_groups": "${{ env.firebase_distribution_groups }}"}'
env:
FIREBASE_APP_DISTRIBUTION_SERVICE_ACCOUNT_CREDS_B64: ${{ secrets.FIREBASE_APP_DISTRIBUTION_SERVICE_ACCOUNT_CREDS_B64 }}
continue-on-error: true # continue to build iOS app even if Android build fails
build-ios-sample-apps:
strategy:
fail-fast: false # if one sample app fails to build, let the other sample apps continue to build and not cancel them.
matrix: # Use a matrix allowing us to build multiple apps in parallel. Just add an entry to the matrix and it will build!
sample-app:
# List all sample apps you want to have compiled.
# List item is name of directory inside of "apps" directory for the corresponding app to compile.
- name: "amiapp_flutter"
cio-workspace-name: "Mobile: Flutter"
defaults:
run:
working-directory: apps/${{ matrix.sample-app.name }}
runs-on: macos-14
name: Building sample app ${{ matrix.sample-app.name }}
steps:
- name: Check out code
uses: actions/checkout@v4
with:
fetch-depth: 0 # Workaround for bug https://github.com/actions/checkout/issues/1471
- name: Get latest SDK version
if: ${{ inputs.use_latest_sdk_version == true }}
id: latest-sdk-version-step
run: |
latest_tag=$(git describe --tags --abbrev=0)
echo "LATEST_TAG=$latest_tag" >> "$GITHUB_OUTPUT"
- name: Set Default Firebase Distribution Groups
shell: bash
env:
# Distribution group constants
ALL_BUILDS_GROUP: all-builds
FEATURE_BUILDS_GROUP: feature-branch
NEXT_BUILDS_GROUP: next
PUBLIC_BUILDS_GROUP: public
# Input variables
CURRENT_BRANCH: ${{ github.ref }}
run: |
# Initialize with the default distribution group
distribution_groups=("$ALL_BUILDS_GROUP")
# Append distribution groups based on branch and context
[[ "$CURRENT_BRANCH" == "refs/heads/feature/"* ]] && distribution_groups+=("$FEATURE_BUILDS_GROUP")
[[ "$CURRENT_BRANCH" == "refs/heads/main" ]] && distribution_groups+=("$NEXT_BUILDS_GROUP")
[[ "$USE_LATEST_SDK_VERSION" == "true" ]] && distribution_groups+=("$PUBLIC_BUILDS_GROUP")
# Export the groups as an environment variable
echo "firebase_distribution_groups=$(IFS=','; echo "${distribution_groups[*]}")" >> $GITHUB_ENV
# Install CLI tools, Ruby, and Ruby dependencies for Fastlane
- name: Install CLI tools used in CI script
shell: bash
run: |
brew install sd # used in CI script as an easier to use sed CLI. Replaces text in files.
brew install xcbeautify # used by fastlane for output
- name: Install Ruby
uses: ruby/setup-ruby@v1
with:
bundler-cache: true # cache tools to make builds faster in future
working-directory: apps/${{ matrix.sample-app.name }}
# Update version numbers and workspace credentials before building the app
- name: Generate New Version
uses: maierj/fastlane-action@v3.1.0
with:
subdirectory: apps/${{ matrix.sample-app.name }}
lane: "generate_new_version"
options: '{"branch_name":"${{ github.ref_name }}", "pull_request_number":"${{ github.event.pull_request.number }}"}'
- name: Update Flutter SDK Version
uses: maierj/fastlane-action@v3.1.0
with:
subdirectory: apps/${{ matrix.sample-app.name }}
lane: "update_flutter_sdk_version"
env:
SDK_VERSION_NAME: ${{ env.SDK_VERSION_NAME }}
APP_VERSION_NAME: ${{ env.APP_VERSION_NAME }}
APP_VERSION_CODE: ${{ env.APP_VERSION_CODE }}
- name: Update Sample App Version
uses: maierj/fastlane-action@v3.1.0
with:
subdirectory: apps/${{ matrix.sample-app.name }}
lane: "update_flutter_app_version"
options: ${{ inputs.use_latest_sdk_version == true && format('{{"version_name":"{0}"}}', steps.latest-sdk-version-step.outputs.LATEST_TAG) || '' }}
env:
SDK_VERSION_NAME: ${{ env.SDK_VERSION_NAME }}
APP_VERSION_NAME: ${{ env.APP_VERSION_NAME }}
APP_VERSION_CODE: ${{ env.APP_VERSION_CODE }}
- name: Setup workspace credentials in flutter environment files
env:
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
COMMIT_HASH: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
run: |
env_file=".env"
touch "$env_file"
echo "BUILD_TIMESTAMP=$(date +%s)" >> "$env_file"
echo "CDP_API_KEY=${{ secrets[format('CUSTOMERIO_{0}_WORKSPACE_CDP_API_KEY', matrix.sample-app.name)] }}" >> "$env_file"
echo "SITE_ID=${{ secrets[format('CUSTOMERIO_{0}_WORKSPACE_SITE_ID', matrix.sample-app.name)] }}" >> "$env_file"
echo "WORKSPACE_NAME=${{ matrix.sample-app.cio-workspace-name }}" >> "$env_file"
echo "BRANCH_NAME=$BRANCH_NAME" >> "$env_file"
echo "COMMIT_HASH=${COMMIT_HASH:0:7}" >> "$env_file"
echo "COMMITS_AHEAD_COUNT=$(git rev-list $(git describe --tags --abbrev=0)..HEAD --count)" >> "$env_file"
if [ "${{ inputs.use_latest_sdk_version }}" == "true" ]; then
echo "SDK_VERSION=${{ steps.latest-sdk-version-step.outputs.LATEST_TAG }}" >> "$env_file"
fi
- name: Setup workspace credentials in iOS environment files
run: |
cp "ios/Env.swift.example" "ios/Env.swift"
sd 'cdpApiKey: String = ".*"' "cdpApiKey: String = \"${{ secrets[format('CUSTOMERIO_{0}_WORKSPACE_CDP_API_KEY', matrix.sample-app.name)] }}\"" "ios/Env.swift"
# Make sure to fetch dependencies only after updating the version numbers and workspace credentials
- name: Setup flutter environment and install dependencies
uses: ./.github/actions/setup-flutter
- name: Use SDK release version for sample app (if needed)
working-directory: apps/amiapp_flutter
run: |
dart run scripts/update_sample_app_sdk_version.dart
cat pubspec.lock
- name: Install flutter dependencies for sample app
run: flutter pub get
- name: Setup iOS environment for sample app
uses: customerio/customerio-ios/.github/actions/setup-ios@main
with:
xcode-version: ${{ env.XCODE_VERSION }}
- name: Cache CocoaPods downloaded dependencies for faster builds in the future
uses: actions/cache@v4
with:
path: Pods
key: ${{ runner.os }}-${{ matrix.sample-app.name }}-Pods-${{ github.ref }}
restore-keys: |
${{ runner.os }}-${{ matrix.sample-app.name }}-Pods
- name: pod install
run: pod install --project-directory=ios
- name: Build and upload iOS app via Fastlane
id: ios_build
uses: maierj/fastlane-action@v3.1.0
with:
subdirectory: apps/${{ matrix.sample-app.name }}
lane: "ios build"
options: '{"distribution_groups": "${{ env.firebase_distribution_groups }}"}'
env:
GOOGLE_CLOUD_MATCH_READONLY_SERVICE_ACCOUNT_B64: ${{ secrets.GOOGLE_CLOUD_MATCH_READONLY_SERVICE_ACCOUNT_B64 }}
FIREBASE_APP_DISTRIBUTION_SERVICE_ACCOUNT_CREDS_B64: ${{ secrets.FIREBASE_APP_DISTRIBUTION_SERVICE_ACCOUNT_CREDS_B64 }}