status-mobile/nix
Jakub Sokołowski e6005dd7c8
nix: use yarn2nix from nixpkgs, stop copying modules
Signed-off-by: Jakub Sokołowski <jakub@status.im>
2020-05-05 20:00:47 +02:00
..
deps/clojure hot reload and re-frisk 1.3.1 2020-05-04 11:22:19 +02:00
desktop nix: reafactoring of status-go builds 2020-05-04 20:55:07 +02:00
lib nix: reafactoring of status-go builds 2020-05-04 20:55:07 +02:00
mobile nix: use yarn2nix from nixpkgs, stop copying modules 2020-05-05 20:00:47 +02:00
pkgs nix: reafactoring of status-go builds 2020-05-04 20:55:07 +02:00
scripts nix: reafactoring of status-go builds 2020-05-04 20:55:07 +02:00
status-go nix: fix ios sim builds, build for amd64 instead 386 2020-05-05 10:34:54 +02:00
tools nix: use symlinks for maven dependencies derivation 2020-05-05 20:00:40 +02:00
DETAILS.md nix: reafactoring of status-go builds 2020-05-04 20:55:07 +02:00
KNOWN_ISSUES.md nix: reafactoring of status-go builds 2020-05-04 20:55:07 +02:00
README.md nix: reafactoring of status-go builds 2020-05-04 20:55:07 +02:00
default.nix Cleanup 2020-01-10 19:59:54 +01:00
nix.conf nix: bump stalled-download-timeout to 10 minutes 2020-01-16 13:31:58 +01:00
overlay.nix nix: reafactoring of status-go builds 2020-05-04 20:55:07 +02:00
pkgs.nix nix: use overlays instead of packageOverrides 2020-04-29 11:53:33 +02:00
shells.nix nix: reafactoring of status-go builds 2020-05-04 20:55:07 +02:00
targets.nix nix: reafactoring of status-go builds 2020-05-04 20:55:07 +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.

NOTE: If you are in Asia you might want to add the https://nix-cache-cn.status.im/ to be first in order of substituters. Removing cache.nixos.org could also help.

Build arguments

We leverage the standard nixpkgs config argument 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:

config = {
  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
    };
  };
};

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

Known Issues

See KNOWN_ISSUES.md.