Oore CI
Ship an Android app

Build your first Android app

Add an app from a local repository, let Oore propose its first pipeline, and download the debug APK.

On this page you create an app for your Flutter app, build a debug APK, and download it. A debug build needs no signing keys, so it is the quickest way to prove that Oore can build your app.

How a build moves from queue to artifact explains what happens between selecting Run build and the download.

What you need

You do not need to check the toolchain in a terminal first. Oore shows what the runner is missing in step 2, with the command that fixes it. To check anyway, run oore doctor --platform android.

1. Add the app

If oore setup asked which folder your app is in, Oore opened with the form filled in: skip to the last step of this list.

  1. In the Oore web UI, open Apps and select Add app.
  2. In Path, enter the absolute path to the app’s Git repository, such as /Users/you/code/my_app. Name follows the folder’s name.
  3. Leave Default branch empty unless Oore should build a branch other than the repository’s default.
  4. Select Add app.

Repository trust

Builds run the repository’s commands with the runner’s macOS account, so add a repository you would run on this Mac yourself. How Oore trusts Direct macOS runners explains why.

Oore opens the app with its setup checklist.

2. Start the first build

Under Add pipeline, Oore reads the repository and says what it found. What it proposes depends on whether the repository has an Oore file.

Without an .oore.yaml

Oore proposes one pipeline per platform folder. Android test app is ticked: it builds a debug APK with flutter build apk --debug and needs no signing. Leave iOS test app unticked for now; it needs signing first.

Under the pipeline, Oore says whether a runner can build it:

  • Builds on a runner’s name: go on.
  • A runner cannot build this yet: each missing tool is listed with the command that fixes it, such as installing a JDK. Run it on this Mac. The runner checks again every 15 minutes.

To write the file yourself instead, run oore init in the repository, commit .oore.yaml, and reload the app’s page: Oore then proposes the file.

With an .oore.yaml

Oore proposes Build from .oore.yaml, since the file already says how to build. Each build reads the file from the commit it builds, so later changes ride with the code. When there are several files, such as a .oore.release.yaml too, the first is ticked.

To use the template instead, select Set up manually and pick Android test app.

Then

Select Create and start the first build. Oore creates the pipeline, starts a build of the default branch and opens the build page. Follow the steps and the log as the runner fetches packages and builds the APK. A first build can take several minutes while Gradle downloads its dependencies.

Check the result

The build ends as Succeeded. Under Artifacts, select Download next to the .apk file. The downloaded file is a non-empty .apk.

To try it, drag the APK onto a running Android emulator, or install it on a phone connected with USB with adb install <file>.apk.

Oore build inventory showing queued, running, successful, failed, and canceled buildsOore build inventory showing queued, running, successful, failed, and canceled builds

Troubleshooting

The build stays queued

Open Settings > Runners. If no runner is Online, run oore status and check the runner service. If Accept builds from approved repositories is off, turn it on. Builds wait while it is off.

The build fails at the Flutter version check

The repository asks for a Flutter release that is not the one installed. Fix the installed version as in Install Flutter where the runner can find it.

Oore could not read the repository

Check that the path is still a Git repository and has a default branch, then reload. Select Add pipeline to set one up by hand meanwhile.

Oore found no Flutter app

The repository has no pubspec.yaml that depends on Flutter at its root. Select Set up manually and set the build commands yourself.

The app form rejects the path

Use an absolute path to a folder that is already a Git repository on this Mac. The Browse button works only when you use Oore on this Mac.

Next step

Sign an Android release.