android-pull-request-workflow.md

(Android) Example Pull Request Workflow

Description

Example workflow for Android Pull Request validation. The workflow contains:

1. Running unit tests
2. Running UI tests on a virtual device
3. Running lint
4. Building a test app and uploading to bitrise.io
5. Sending the QR code of the test build to the Pull Request
6. Triggering the Workflow for pull requests.

Instructions

Copy the yaml contents from below and make sure that the following env vars have the correct settings:

• $PROJECT_LOCATION
• $MODULE
• $VARIANT

Also generate a new Github access token and add a new secret called GITHUB_ACCESS_TOKEN with the newly generated token value.

bitrise.yml

---
format_version: '17'
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
project_type: android

meta:
  bitrise.io:
    stack: linux-docker-android-22.04
    machine_type_id: standard

workflows:
  pull-request:
    steps:
    - activate-ssh-key@4:
        run_if: '{{getenv "SSH_RSA_PRIVATE_KEY" | ne ""}}'
    - git-clone@8: {}
    - restore-gradle-cache@2: {}
    - android-unit-test@1:
        inputs:
        - project_location: $PROJECT_LOCATION
        - variant: $VARIANT
    - android-build-for-ui-testing@0:
        inputs:
        - variant: $VARIANT
        - module: $MODULE
    - virtual-device-testing-for-android@1:
        inputs:
        - test_type: instrumentation
    - android-lint@0:
        inputs:
        - variant: $VARIANT
    - android-build@1:
        inputs:
        - project_location: $PROJECT_LOCATION
        - module: $MODULE
        - variant: $VARIANT
    - deploy-to-bitrise-io@2: {}
    - create-install-page-qr-code@1: {}
    - comment-on-github-pull-request@0:
        inputs:
        - body: |-
            ![QR code]($BITRISE_PUBLIC_INSTALL_PAGE_QR_CODE_IMAGE_URL)

            $BITRISE_PUBLIC_INSTALL_PAGE_URL
        - personal_access_token: $GITHUB_ACCESS_TOKEN
    - save-gradle-cache@1: {}

app:
  envs:
  - PROJECT_LOCATION: "."
    opts:
      is_expand: false
  - MODULE: app
    opts:
      is_expand: false
  - VARIANT: debug
    opts:
      is_expand: false

trigger_map:
- pull_request_source_branch: "*"
  workflow: pull-request