status-react/nix
Icaro Motta 9dad4716d6
Upgrade re-frame (#15997)
This commit upgrades re-frame to v1.3.0 (latest stable release), released ~9
months ago, in 2022-08-27. This is a solid upgrade, with no breaking changes as
far as I tested status-mobile. It's a great testament of re-frame's stability
and commitment to backwards compatibility, as are many Clojure libs.

Fixes https://github.com/status-im/status-mobile/issues/15963

The big, and truly relevant addition is the introduction of the :fx built-in
effect that was added ~3 years ago in Aug/2020 in v1.1.0.

Relevant changelog:

- Global interceptors are now supported (added in v1.0.0).
- reg-event-fx will just warn (not generate an error) if the effect map returned
  contains an unknown effect key.
- re-frame will now warn us when we are calling subscribe outside of a reactive
  context.
- "re-frame now guarantees that a :db effect, if present, will be actioned
  before any other sibling effects. re-frame continues to provide NO guarantees
  about the order in which other effects will be actioned."
  (https://day8.github.io/re-frame/releases/2020/#110-2020-08-24)
- There's syntactic sugar for trivial reg-sub declarations (added in v1.3.0).
  See the documentation for reg-sub for more details
  https://day8.github.io/re-frame/api-re-frame.core/#reg-sub
- "The built-in effect :dispatch-later can now take a single map value.
  Supplying a sequence of maps is now deprecated in favor of using multiple
  :dispatch-later effects within the new :fx effect."
  https://day8.github.io/re-frame/releases/2020/#111-2020-08-26
2023-05-31 06:08:34 -03:00
..
deps Upgrade re-frame (#15997) 2023-05-31 06:08:34 -03:00
lib nix: cleanup of unused variables 2022-05-31 12:03:20 +02:00
mobile nix: use jsbundle derivation for iOS as well 2023-05-22 10:31:09 +02:00
pkgs nix: disable sandboxing for xcodewrapper 2023-04-28 11:24:16 +02:00
scripts Use native binary for the clj-kondo linter (#14179) 2022-10-19 09:54:01 -03: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: upgrade from 2.8.0 to 2.11.1 2022-09-20 19:03:10 +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 ci: disable sandbox for status-go iOS builds 2022-09-01 16:17:47 +02:00
overlay.nix nix: add ios-deploy package to ios shell 2023-04-20 20:17:38 +02:00
pkgs.nix nix: bump nixpkgs to include fix for apksigner 2023-04-07 18:05:50 +02:00
shell.nix nix: add procps to default shell, and tcl for darwin 2023-03-10 16:19:11 +01:00
shells.nix nix: add ios-deploy package to ios shell 2023-04-20 20:17:38 +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.