status-react/nix
Jakub Sokołowski e2c18ea151
add commit hash to app metadata for Android and iOS
This will make identifying installed software easier.
It can also be used to generate F-Droid RPs more easily.

Depends on:
https://github.com/status-im/status-jenkins-lib/pull/35

Signed-off-by: Jakub Sokołowski <jakub@status.im>
2021-09-21 11:48:45 +02:00
..
deps target SDK 30 2021-09-13 10:17:51 +03:00
lib nix: upgrade nixpkgs, keep Go at 1.14.15 2021-06-15 17:49:33 +02:00
mobile add commit hash to app metadata for Android and iOS 2021-09-21 11:48:45 +02:00
pkgs nix: drop our gomobile in favor of one from nixpkgs 2021-09-14 11:31:17 +02:00
scripts nix: upgrade Nix 2.3.6 to 2.3.12 2021-06-15 17:49:27 +02:00
status-go nix: rafactor android-sdk to provide sdk/ndk outputs 2021-09-14 10:52:41 +02:00
tools nix: upgrade nixpkgs, keep Go at 1.14.15 2021-06-15 17:49:33 +02:00
DETAILS.md
KNOWN_ISSUES.md nix: add info about NDK bundle download issues 2020-10-19 12:07:00 +02:00
README.md nix: drop references to nix-cache-cn.status.im 2021-05-25 17:53:47 +02:00
config.nix add commit hash to app metadata for Android and iOS 2021-09-21 11:48:45 +02:00
default.nix
nix.conf nix: drop references to nix-cache-cn.status.im 2021-05-25 17:53:47 +02:00
overlay.nix nix: drop our gomobile in favor of one from nixpkgs 2021-09-14 11:31:17 +02:00
pkgs.nix nix: upgrade nixpkgs, clean up android sdk config 2021-09-14 10:53:36 +02:00
shell.nix
shells.nix nix: add missing cljfmt dependencies to nix/deps/clojure 2021-03-01 16:42:38 +01:00
targets.nix drop all desktop related files and references 2020-07-08 10:26:51 +02:00

README.md

Description

This folder contains configuration for Nix, a purely functional package manager used by the Status app for its build process.

Configuration

The main config file is nix/nix.conf and its main purpose is defining the binary caches which allow download of packages to avoid having to compile them yourself locally.

Build arguments

We leverage the config argument of standard nixpkgs for our own parameterization of the builds (e.g. to pass a build number or build type).

Here is a sample structure of the config attribute set:

{
  status-im = {
    build-type = "pr";     # Build type (influences which .env file gets used for feature flags)
    build-number = 9999;   # Used for versionCode and CFBundleVersion in Android and iOS respectively
    android = {
      gradle-opts = "";    # Gradle options passed for Android builds
      keystore-path = "";  # Path to keystore for signing the APK
      abi-split = false;   # If APKs should be split based on architectures
      abi-include = "x86"; # Android architectures to build for
    };
    status-go = {
      src-override = "$HOME/my/source/status-go"; # local source override
    };
  };
}

You can see the defaults in nix/config.nix.

Shell

In order to access an interactive Nix shell a user should run make shell.

The Nix shell is started in this repo via the nix/scripts/shell.sh script, which is a wrapper around the nix-shell command and is intended for use with our main Makefile. This allows for an implicit use of nix-shell as the default shell in the Makefile.

Normally the shell starts without any specific target platform, if you want to change that you should export the TARGET env variable with appropriate value:

make shell TARGET=android

This way your shell and all other nix commands should run in a setup that is tailored towards Android development.

For valid values you can check the nix/shells.nix file.

Using a local status-go repository

If you need to use a locally checked-out status-go repository, you can achieve that by defining the STATUS_GO_SRC_OVERRIDE environment variable:

export STATUS_GO_SRC_OVERRIDE=$GOPATH/src/github.com/status-im/status-go
make release-android

Resources

You can learn more about Nix by watching these presentations:

And you can read nix/DETAILS.md for more information.

Known Issues

See KNOWN_ISSUES.md.