status-im
/
status-react
mirror of https://github.com/status-im/status-react.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
status-react/nix
History
Siddarth Kumar 4eff9cc39c
fix: don't show trace message when default is set (#18464) 
`getEnvWithDefault.nix` prints a trace message in console when a default value is not set. 

In this commit we add a check to see if default value matches the value of that env var.
Otherwise we get log messages like these when running `make run-ios`

```
trace: getEnvWithDefault IOS_STATUS_GO_TARGETS 
(default: ios/arm64;iossimulator/amd64): ios/arm64;iossimulator/amd64
trace: getEnvWithDefault IOS_STATUS_GO_TARGETS 
(default: ios/arm64;iossimulator/amd64): ios/arm64;iossimulator/amd64
```

We also fix a tiny mistake in `make run-ios` status-go target by updating the delimiter to be a semi-colon instead of a comma.
 		2024-01-11 14:57:28 +05:30
..
deps fix: boost checksum issue due to jfrog (#18434) 2024-01-08 23:55:36 +05:30
lib fix: don't show trace message when default is set (#18464) 2024-01-11 14:57:28 +05:30
mobile feat: add `xcbeautify` to iOS shell (#18273) 2023-12-22 19:45:59 +05:30
pkgs feat: add `xcbeautify` to iOS shell (#18273) 2023-12-22 19:45:59 +05:30
scripts nix: fix regex in clean.sh script 2024-01-10 13:05:39 +01:00
status-go ci: upgrade CI hosts to Xcode 15.1 2024-01-07 22:24:35 +01: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 ci: upgrade CI hosts to Xcode 15.1 2024-01-07 22:24:35 +01:00
pkgs.nix nix: switch status-im config to env vars, cleanup 2023-08-07 14:50:36 +02:00
shell.nix chore: add lsp clean-ns in lint-fix (#17661) 2023-10-18 00:17:43 +08:00
shells.nix add translation linting to the "make lint" pipeline. (#17820) 2023-11-07 11:33:59 +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 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:

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

Known Issues

See KNOWN_ISSUES.md.