History

Icaro Motta b73ac6b107 Upgrade clj-kondo and configure new linters (#17543 ) - Upgrade clj-kondo to latest version to take advantage of new linters. From version 2023.04.14 https://github.com/clj-kondo/clj-kondo/blob/master/CHANGELOG.md#20230414 to 2023.09.07 https://github.com/clj-kondo/clj-kondo/blob/master/CHANGELOG.md#20230907 - Use new linter ":unused-alias" and set at WARN level for the moment, because otherwise the PR would increase a bit too much, but it did catch many unused "require" aliases. Added in version 2023.09.07 https://github.com/clj-kondo/clj-kondo/blob/master/CHANGELOG.md#20230907 - Use new linter ":case-symbol-test" and fix the reported errors, added in version 2023.07.13 https://github.com/clj-kondo/clj-kondo/blob/master/CHANGELOG.md#20230713 - Use new linters ":equals-true", ":plus-one", and ":minus-one" and fix reported errors, added in version 2023.05.18 https://github.com/clj-kondo/clj-kondo/blob/master/CHANGELOG.md#20230518 - Raise level from WARN to ERROR for linter "uninitialized-var". - Explicitly add ":case-duplicate-test" to clj-kondo config, renamed in version 2023.07.13 https://github.com/clj-kondo/clj-kondo/blob/master/CHANGELOG.md#20230713 - Explicitly add ":case-quoted-test" to clj-kondo config, renamed in version 2023.07.13 https://github.com/clj-kondo/clj-kondo/blob/master/CHANGELOG.md#20230713 - Explicitly add ":deprecated-namespace" to clj-kondo config, added in version 2023.07.13 https://github.com/clj-kondo/clj-kondo/blob/master/CHANGELOG.md#20230713 Fixes https://github.com/status-im/status-mobile/issues/17287		2023-10-05 15:50:57 -03:00
..
deps	Dont parse unused identicon	2023-09-06 14:09:37 +01:00
lib	nix: switch status-im config to env vars, cleanup	2023-08-07 14:50:36 +02:00
mobile	nix: set ios status-go targets	2023-09-07 14:15:30 +02:00
pkgs	nix: downgrade watchman to 4.9.0	2023-07-02 08:46:28 +02:00
scripts	nix: switch status-im config to env vars, cleanup	2023-08-07 14:50:36 +02:00
status-go	Update status-go to v0.167.6	2023-10-04 01:16:25 +03:00
DETAILS.md	nix: switch status-im config to env vars, cleanup	2023-08-07 14:50:36 +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: switch status-im config to env vars, cleanup	2023-08-07 14:50:36 +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	Upgrade clj-kondo and configure new linters (#17543 )	2023-10-05 15:50:57 -03:00
pkgs.nix	nix: switch status-im config to env vars, cleanup	2023-08-07 14:50:36 +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: make fetching Gradle dependencies more generic	2023-09-04 09:57:53 +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 environment variables for parameterization of the builds (e.g. to pass a build number or build type).

Here is the list of variables you can use to override defaults:

# Build type (influences which .env file gets used for feature flags)
export BUILD_TYPE="pr"
# Used for versionCode and CFBundleVersion in Android and iOS respectively
export BUILD_NUMBER=9999
# Gradle options passed for Android builds
export ANDROID_GRADLE_OPTS=""
# If APKs should be split based on architectures
export ANDROID_ABI_SPLIT=false
# Android architectures to build for
export ANDROID_ABI_INCLUDE="x86"
# Local source override, see below
export STATUS_GO_SRC_OVERRIDE="$HOME/my/source/status-go"
export STATUS_GO_IPFS_GATEWAY_URL="https://ipfs.status.im/"

You can see the defaults in code:

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:

Nix Fundamentals (PDF, src)
Nix in Status (PDF, src)

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

Known Issues

See KNOWN_ISSUES.md.