Skip to content

Report a build

Kifas tests mobile apps on the build your CI produces. kifasio/report-build@v1 is the one step you add to the end of your existing build workflow: it tells Kifas “here is the APK for commit abc1234 of org/repo, PR #12”. Kifas downloads the file into its own storage right away and never keeps your signed URL.

Anything in Kifas that reacts to a merged pull request — suggested tests, suite runs — waits for the build of that merge commit and runs against that build. If the build takes a while, the run shows as awaiting build on the suite page and starts the moment the build arrives. If no build is reported within 60 minutes, the run is marked failed with the reason build_never_arrived, in the same place every other failure shows.

  1. Build the APK the way you already do.
  2. Report it with kifasio/report-build@v1, either as a file path (apk-path) or as an https URL Kifas can fetch (apk-url, public or presigned).
name: Build APK
on:
push:
branches: [main]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '17'
- name: Build
run: ./gradlew assembleDebug
- name: Report the build to Kifas
uses: kifasio/report-build@v1
with:
api-key: ${{ secrets.KIFAS_API_KEY }}
apk-path: app/build/outputs/apk/debug/app-debug.apk

KIFAS_API_KEY is the same key you use for kifasio/e2e-action (scope workflow:run). The repository must be connected to Kifas — the Kifas GitHub App installed with the repo on its allow list — or the step fails with repo not connected to Kifas.

Input Required Default What it does
api-key yes — Kifas API key with the workflow:run scope.
apk-url one of — https URL of the built .apk. Kifas downloads it once (500 MB cap).
apk-path one of — Local path of the built .apk; uploaded directly when your CI has no object store.
api-base no https://api.kifas.io Override for self-hosted deployments.

Output app-build-id is the Kifas build id, also printed with a link to the Devices page in the job summary.

The action reads the repository, commit, branch, workflow run id and pull-request number from the runner environment. A push to main carries no pull-request number; Kifas resolves the PR from the merge commit itself.

Reporting the same commit twice keeps the build id and atomically publishes a new immutable stored file with its matching metadata. There is one active build row per repository and commit; concurrent reports cannot mix one report’s metadata with another report’s bytes.

The Android demo app uses a Gradle APK build. The two-step workflow above shows how to report its debug APK after ./gradlew assembleDebug.

If your CI already uploads the APK to object storage, replace apk-path with the public or presigned download URL from that upload step:

- name: Report the uploaded APK
uses: kifasio/report-build@v1
with:
api-key: ${{ secrets.KIFAS_API_KEY }}
apk-url: ${{ steps.upload.outputs.url }}

Kifas authenticates this call with the API key. Your CI remains responsible for access to its own object storage. The action does not print the download URL or credentials.

For a repeatable demonstration using a prebuilt APK, the selected artifact must match the checked-out commit or its exact Git tree. Fail the reporting step when no matching artifact exists; never label an unrelated latest APK with the current commit.

  • Devices → App builds lists every build with its repo, branch, commit (linked to GitHub), PR number and how many runs used it.
  • A run that used a reported build shows ran on build abc1234 (PR #12) under its title.
  • A suite waiting for a build shows awaiting build abc1234 in its history until the build arrives.

See Suites for gating a pull request with kifasio/e2e-action.