diff options
| author | David Göransson <david.goransson@mullvad.net> | 2025-05-20 10:12:12 +0200 |
|---|---|---|
| committer | David Göransson <david.goransson@mullvad.net> | 2025-05-21 11:56:46 +0200 |
| commit | f2b6a3d2d04d33e106b794ae489d506651f41f91 (patch) | |
| tree | 3946e8dc8792199eab45e6fee3d31775aa773fb8 /android/BuildInstructions.md | |
| parent | 39eccff2fbdd35e7a427877f77a31eef1510284a (diff) | |
| download | mullvadvpn-f2b6a3d2d04d33e106b794ae489d506651f41f91.tar.xz mullvadvpn-f2b6a3d2d04d33e106b794ae489d506651f41f91.zip | |
Update with new property references
Diffstat (limited to 'android/BuildInstructions.md')
| -rw-r--r-- | android/BuildInstructions.md | 25 |
1 files changed, 15 insertions, 10 deletions
diff --git a/android/BuildInstructions.md b/android/BuildInstructions.md index da38741f40..161685fa89 100644 --- a/android/BuildInstructions.md +++ b/android/BuildInstructions.md @@ -207,7 +207,7 @@ in the following way: 1. Run update script: ```bash - ./scripts/update-lockfile.sh + ./scripts/lockfile -u ``` If you're on macOS make sure GNU sed is installed. Install with `brew install gnu-sed` and add it to your `PATH` so that it is used instead of the `sed` macOS ships with `PATH="$HOMEBREW_PREFIX/opt/gnu-sed/libexec/gnubin:$PATH"` @@ -221,25 +221,30 @@ rm ./gradle/verification-metadata.xml ``` ## Gradle properties -Some gradle properties can be set to simplify development. These are listed below. +Some gradle properties can be set to simplify development, for the full list see `android/gradle.properties`. +In order to override them, add the properties in `<USER_GRADLE_HOME>/gradle.properties`. See the +[gradle documentation](https://docs.gradle.org/current/userguide/build_environment.html#sec:project_properties) +for more info of the prioritization of properties. ### Override version code and version name -To avoid or override the rust based version generation, the `OVERRIDE_VERSION_CODE` and -`OVERRIDE_VERSION_NAME` properties can be set in `local.properties`. For example: +To avoid or override the rust based version generation, the `mullvad.app.config.override.versionCode` and +`mullvad.app.config.override.versionName` properties can be set: ``` -OVERRIDE_VERSION_CODE=123 -OVERRIDE_VERSION_NAME=1.2.3 +mullvad.app.config.override.versionCode=123 +mullvad.app.config.override.versionName=1.2.3 ``` ### Disable version in-app notifications To disable in-app notifications related to the app version during development or testing, -the `ENABLE_IN_APP_VERSION_NOTIFICATIONS` property can be set in `local.properties`: +the `mullvad.app.config.inAppVersionNotifications.enable` property can be set: ``` -ENABLE_IN_APP_VERSION_NOTIFICATIONS=false +mullvad.app.config.inAppVersionNotifications.enable=false ``` ### Run tests highly affected by rate limiting -To avoid being rate limited we avoid running tests sending requests that are highly rate limited too often. If you want to run these tests you can set `enable_highly_rate_limited_tests=true` in `local.properties`. The default value is `false`. +To avoid being rate limited we avoid running tests sending requests that are highly rate limited +too often. If you want to run these tests you can override the +`mullvad.test.e2e.config.runHighlyRateLimitedTests` gradle properties. The default value is `false`. ## Reproducible builds @@ -249,7 +254,7 @@ The Mullvad Android app is by default reproducible when built using our build co When building without the container on Linux systems, reproducibility depends on having the exact same versions of system tools (compilers, build tools, etc) installed. Small differences in tool versions or configurations can lead to different build outputs even when using the same source code. -> **Make sure that the `local.properties` file has not changed keys that affect the reproducibility of the build such as `CARGO_TARGETS` and `ENABLE_IN_APP_VERSION_NOTIFICATIONS`.** +> **Make sure that any `gradle.properties` has not changed or been overridden it will affect the reproducibility of the build such as changing `mullvad.app.build.cargo.targets` and `mullvad.app.config.inAppVersionNotifications.enable`.** To maximize reproducibility when building without the container: |
