diff --git a/apps/mobile-app/android/fdroid/README.md b/apps/mobile-app/android/fdroid/README.md index 7c58724bc..3e04ce1bb 100644 --- a/apps/mobile-app/android/fdroid/README.md +++ b/apps/mobile-app/android/fdroid/README.md @@ -1,16 +1,16 @@ -1. Clone +# F-Droid local test builds +This folder contains Docker container scripts for testing F-Droid builds locally. +When you run the local setup, it automatically pulls the latest `main` branch from aliasvault/aliasvault and builds the app. This process verifies that all app sources are fully FOSS (Free and Open Source Software). + +## Run local F-Droid build against latest main branch + +1. Build and run the F-Droid docker container ```bash -git clone https://gitlab.com/fdroid/fdroiddata.git --depth=1 -git clone https://gitlab.com/fdroid/fdroidserver.git --depth=1 +./run.sh ``` -2. Build docker image and run docker compose in attach mode -```bash -docker compose build && docker compose run --rm fdroid-buildserver -``` - -3. Inside the Docker container, run this: +2. Inside the Docker container, run this: ```bash ./build.sh ``` @@ -36,3 +36,26 @@ BUILD SUCCESSFUL in 30m 25s 1564 actionable tasks: 1563 executed, 1 up-to-date 2025-11-03 16:40:56,157 INFO: Successfully built version 0.99.0-test1 of net.aliasvault.app from 97d8d4d15df88cd759b62489368e857291a27078 ``` + +This is the important part to know whether the build was succesful: +> BUILD SUCCESSFUL in 30m 25s + +Other warnings can be ignored as they are most likely about versions not matching, but that is to be expected as we have hardcoded the version to 0.1.0 while the actual version extracted from the Android build.gradle file will be different. + +## Run F-Droid build against specific commit +If you wish to test F-Droid which a specific commit, edit the `net.aliasvault.app.yml` file and change the `commit` line here: + +```yaml + - versionName: 0.1.0 + versionCode: 1 + commit: main +``` + +to include a specific commit: +```yaml + - versionName: 0.1.0 + versionCode: 1 + commit: 4010631d7380fc4ca5538a43afd21527287fd913 +``` + +Then run the above build again, which will now checkout this specific commit and try to build it. \ No newline at end of file