status-react/nix
Jakub Sokołowski 1503f6b250
nix: use Darwin stat command explicitly
Otherwise if in Nix context we can accidentally use GNU stat which
results in a different output due to different command line flags:
```
[nix-shell:~/status-mobile]$ stat -Lf "%Sg" "/nix/store"
stat: cannot read file system information for '%Sg': No such file or directory
  File: "/nix/store"
    ID: 10000110000001a Namelen: ?       Type: apfs
Block size: 4096       Fundamental block size: 4096
Blocks: Total: 242837545  Free: 199242283  Available: 199242283
Inodes: Total: 7971454780 Free: 7969691320
```
And it should be just owner group name or ID. Which in turn results in:
```
Unknown Nix installtion type!
```

Signed-off-by: Jakub Sokołowski <jakub@status.im>
2023-06-27 13:25:41 +02:00
..
deps android: fix Gradle deps, drop Flipper, upgrade Fresco 2023-06-23 12:02:18 +02:00
lib nix: cleanup of unused variables 2022-05-31 12:03:20 +02:00
mobile upgrade `react-native` from 0.67.5 to 0.69.10 (#16016) 2023-06-14 07:17:41 +05:30
pkgs nix: fix Android SDK on Darwin with nixpkgs system override 2023-06-26 17:33:44 +02:00
scripts nix: use Darwin stat command explicitly 2023-06-27 13:25:41 +02:00
status-go Upgrade `react-native` from 0.63.3 to 0.67.5 (#15486) 2023-04-12 15:25:19 +05:30
tools nix: cleanup of unused variables 2022-05-31 12:03:20 +02:00
DETAILS.md nix: use jsbundle derivation for iOS as well 2023-05-22 10:31:09 +02:00
KNOWN_ISSUES.md nix: fix applying nix.conf by using correct env var 2023-06-20 13:55:07 +02:00
README.md nix: build unsigned Android APK, sign separately 2022-05-21 11:10:11 +02:00
config.nix ci: use different IPFS gateway for release builds 2022-08-26 20:02:27 +02:00
default.nix Cleanup 2020-01-10 19:59:54 +01:00
nix.conf nix: build derivation from sources if cache fails 2023-06-25 23:34:59 +02:00
overlay.nix nix: skip git-lfs checks failing on darwin 2023-06-26 10:49:32 +02:00
pkgs.nix nix: fix Android SDK on Darwin with nixpkgs system override 2023-06-26 17:33:44 +02:00
shell.nix nix: add missing Apple SDKs to fix make test on macOS 2023-06-24 10:56:21 +02:00
shells.nix nix: upgrade nixpkgs to latest nixos-22.11 2023-06-20 12:53:06 +02: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
      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.

⚠️ WARNING: To have Nix pick up all changes a new nix-shell needs to be spawned.

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.