name: Maestro # Run this flow only on pull request, and only when the pull request has the Run-Maestro label, to limit our usage of maestro cloud. on: workflow_dispatch: pull_request: types: [labeled] # Enrich gradle.properties for CI/CD env: GRADLE_OPTS: -Dorg.gradle.jvmargs=-Xmx9g -XX:MaxMetaspaceSize=512m -Dfile.encoding=UTF-8 -XX:+HeapDumpOnOutOfMemoryError -XX:+UseG1GC -Dkotlin.daemon.jvm.options=-Xmx4g -Dkotlin.incremental=false CI_GRADLE_ARG_PROPERTIES: --stacktrace --no-daemon -Dsonar.gradle.skipCompile=true jobs: build-apk: name: Build APK runs-on: ubuntu-latest if: github.event_name == 'workflow_dispatch' || github.event.label.name == 'Run-Maestro' # Allow one per PR. concurrency: group: ${{ format('maestro-{0}', github.ref) }} cancel-in-progress: true steps: - name: Remove Run-Maestro label if: ${{ github.event_name == 'pull_request' && github.event.label.name == 'Run-Maestro' }} uses: actions-ecosystem/action-remove-labels@v1 with: labels: Run-Maestro - uses: actions/checkout@v4 if: (github.event_name == 'pull_request' && github.event.pull_request.fork == null) || github.event_name == 'workflow_dispatch' with: # Ensure we are building the branch and not the branch after being merged on develop # https://github.com/actions/checkout/issues/881 ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.ref }} - uses: actions/setup-java@v4 name: Use JDK 17 if: (github.event_name == 'pull_request' && github.event.pull_request.fork == null) || github.event_name == 'workflow_dispatch' with: distribution: 'temurin' # See 'Supported distributions' for available options java-version: '17' - name: Configure gradle uses: gradle/actions/setup-gradle@v4 with: cache-read-only: ${{ github.ref != 'refs/heads/develop' }} - name: Assemble debug APK run: ./gradlew :app:assembleGplayDebug $CI_GRADLE_ARG_PROPERTIES if: (github.event_name == 'pull_request' && github.event.pull_request.fork == null) || github.event_name == 'workflow_dispatch' env: ELEMENT_ANDROID_MAPTILER_API_KEY: ${{ secrets.MAPTILER_KEY }} ELEMENT_ANDROID_MAPTILER_LIGHT_MAP_ID: ${{ secrets.MAPTILER_LIGHT_MAP_ID }} ELEMENT_ANDROID_MAPTILER_DARK_MAP_ID: ${{ secrets.MAPTILER_DARK_MAP_ID }} - name: Upload APK as artifact uses: actions/upload-artifact@v4 with: name: elementx-apk-maestro path: | app/build/outputs/apk/gplay/debug/app-gplay-x86_64-debug.apk retention-days: 5 overwrite: true if-no-files-found: error maestro-cloud: name: Maestro test suite runs-on: ubuntu-latest needs: build-apk if: github.event_name == 'workflow_dispatch' || github.event.label.name == 'Run-Maestro' # Allow one per PR. concurrency: group: ${{ format('maestro-{0}', github.ref) }} cancel-in-progress: true steps: - uses: actions/checkout@v4 if: (github.event_name == 'pull_request' && github.event.pull_request.fork == null) || github.event_name == 'workflow_dispatch' with: # Ensure we are building the branch and not the branch after being merged on develop # https://github.com/actions/checkout/issues/881 ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.ref }} - name: Download APK artifact from previous job uses: actions/download-artifact@v4 with: name: elementx-apk-maestro - uses: mobile-dev-inc/action-maestro-cloud@v1.9.1 if: (github.event_name == 'pull_request' && github.event.pull_request.fork == null) || github.event_name == 'workflow_dispatch' with: api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }} # Doc says (https://github.com/mobile-dev-inc/action-maestro-cloud#android): # app-file should point to an x86 compatible APK file, so upload the x86_64 one (much smaller than the universal APK). app-file: app-gplay-x86_64-debug.apk env: | MAESTRO_USERNAME=maestroelement MAESTRO_PASSWORD=${{ secrets.MATRIX_MAESTRO_ACCOUNT_PASSWORD }} MAESTRO_RECOVERY_KEY=${{ secrets.MATRIX_MAESTRO_ACCOUNT_RECOVERY_KEY }} MAESTRO_ROOM_NAME=MyRoom MAESTRO_INVITEE1_MXID=@maestroelement2:matrix.org MAESTRO_INVITEE2_MXID=@maestroelement3:matrix.org MAESTRO_APP_ID=io.element.android.x.debug