7.2 KiB

Raw Blame History

Description

This document describes how to update Status APK builds for the F-Droid Android application catalogue.

Intro

In simplest terms F-Droid requires a YAML file that defines the steps necessary to create a universal unsigned APK build. This is achieved by submitting a new app version into the metadata/im.status.ethereum.yml file in the fdroiddata repository.

The app builds defined this way run on servers that generate the unsigned APKs using the fdroidserver software. The server setup is quite involved but is not necessary unless you want to run your own instance. Normally the applications defined in fdroiddata are built by servers maintained by the F-Droid volunteers.

First release of Status app was merged in fdroid/fdroiddata#7179.

⚠️ WARNING: Once changes are committed into fdroiddata repo they cannot be changed.

Adding New Versions

There are two ways - automated and manual - described below.

Automated

The script will analyze a provided APK, update the metadata file based on that information, and commit the change to fdroiddata repo. The creation of merge request is manual.

Requirements:

GitLab account
Forked copy of the fdroiddata repo
Link to the release published

Steps

Use the F-Droid PR update script via make:
```
make fdroid-pr APK=StatusIm-Mobile-v1.16.0-ef34af.apk
```
The script also accepts a URL.

Add a fork repo:

git remote add john https://gitlab.com/john/fdroiddata.git

Push:
```
git push john status-im/v1.16.0
```
Create a PR via the GitLab interface.

Manual

You can find our configuration file at metadata/im.status.ethereum.yml

The file defines all the necessary metadata like SourceCode, Website, or License, but the most important key is Builds, which looks like this:

Builds:
  - versionName: 1.12.0
    versionCode: 2021022512
    commit: cfb825a11b61d312af8cb5d36686af540c31f481
    sudo:
      - cd build/im.status.ethereum
      - make fdroid-build-env
    init: nix/scripts/setup.sh
    output: result/app-release-unsigned.apk
    scanignore:
      - android/build.gradle
    scandelete:
      - ios
    build: make release-fdroid BUILD_NUMBER=$$VERCODE$$

It contains a list of objects defining each release of the application. In order to add a new release simply copy a previous release object and adjust the following values:

versionName - String version like 1.12.0.
versionCode - Android versionCode. Normally it is generated from timestamp at build time.
commit - Specific commit SHA1 from which the given release was built.

The versionCode should be the same as the one in build that was uploaded to Play Store. It can be found in the build logs or by using:

 > make shell TARGET=android
 > apkanalyzer manifest version-code StatusIm-Mobile-v1.12.0.apk
2021022512

At the bottom of the file you should also update the following keys:

CurrentVersion - Same as the new versionName added
CurrentVersionCode - Same as the versionCode added

Then submit a merge request with Draft: prefix to the fdroid/fdroiddata repository. Prefix is necessary to avoid F-Droid people merging the PR before it's ready.

⚠️ WARNING: Currently GitLab PR builds will fail due to running as root instead of vagrant and failing to install Nix.

Checking Builds

The simplest way to test if the app builds via F-Droid is to use the Docker image: https://gitlab.com/fdroid/docker-executable-fdroidserver

Which is available under registry.gitlab.com/fdroid/docker-executable-fdroidserver:latest.

Because we use Nix to build the mobile app we need to slightly modify the image with this Dockerfile:

FROM registry.gitlab.com/fdroid/docker-executable-fdroidserver:latest
ARG BUILDER_UID=1000
ENV BUILDER_USER=vagrant
RUN useradd -u $BUILDER_UID $BUILDER_USER
RUN mkdir -m 0755 /nix /home/$BUILDER_USER \
 && chown -R $BUILDER_USER /nix /home/$BUILDER_USER

Build it using:

docker build --build-arg=BUILDER_UID=$UID -t statusteam/docker-executable-fdroidserver:latest .

Then clone the fdroiddata and fdroidserver repos and use it to test the build of a specific Status Android app version: 1.12.0

git clone https://gitlab.com/fdroid/fdroidserver
git clone https://gitlab.com/fdroid/fdroiddata
docker run --rm \
  -u $UID:$GID -e USER=vagrant \
  -v $PWD/fdroiddata:/repo \
  -v $PWD/fdroidserver:/fdroidserver \
  statusteam/docker-executable-fdroidserver:latest \
  build im.status.ethereum

We have to create a user and specify the UID because Nix cannot run as root and that is the default user for the F-Droid Docker image. By adding our own user and setting the UID we also make it possible to mount folders like fdroiddata and fdroidserver.

You can specify a --verbose flag for build command for additional information. You can provide --storage-opt size=30G flag if Docker complains about running out of space.

You should also run lint and rewritemeta for the App ID to verify and fix the YAML metadata formatting.

Details

The original research was done in #8512.

Normally F-Droid server wants to run Gradle itself, but we do not specify the gradle key in order to run make release-fdroid ourselves in build step. We also add android/build.gradle to scanignore to avoid F-Droid trying to use Gradle directly.

The Android metadata like description or screenshots is loaded from our repository based on the Fastlane supply tool folder structure for updating Google Play store metadata.

Once the PR is merged it may take a few days for the F-Droid server farm to build and deploy the new version to their site and app. You can look up the current state of builds here and look for your App ID and a deploy change after it.

F-Droid Build

F-Droid requires submitted applications to be free of non Open Source software. For this reason we need to exclude certain Google libraries at build time.

This is achieved by setting GOOGLE_FREE=1 in the .env.release file. This affects two things:

Clojure code conditional which stops use of get-referrer.
Gradle build configuration by excluding Google libraries.

Both are affected by the .env file and both are required.

7.2 KiB Raw Blame History