Jakub Sokołowski
5f50a8c39a
This is a mild upgrade that should not cause any controversy. You can read about changes here: - https://nixos.org/manual/nix/stable/release-notes/rl-2.12.html - https://nixos.org/manual/nix/stable/release-notes/rl-2.13.html - https://nixos.org/manual/nix/stable/release-notes/rl-2.14.html Relevant `infra-ci` change: - https://github.com/status-im/infra-ci/commit/e4e9796f The simplest way to upgrade to `2.14` your version locally is using: ```sh nix-channel --update nix-env -iA nixpkgs.nixVersions.nix_2_14 nixpkgs.cacert sudo systemctl daemon-reload sudo systemctl restart nix-daemon ``` For MacOS the instructions are a bit different: https://nixos.org/manual/nix/stable/installation/upgrading.html Keep in mind you should use `nixpkgs.nixVersions.nix_2_14` instead of just `nixpkgs.nix` to avoid getting newer than `2.14`. Signed-off-by: Jakub Sokołowski <jakub@status.im> |
||
|---|---|---|
| .. | ||
| deps | ||
| lib | ||
| mobile | ||
| pkgs | ||
| scripts | ||
| status-go | ||
| tools | ||
| DETAILS.md | ||
| KNOWN_ISSUES.md | ||
| README.md | ||
| config.nix | ||
| default.nix | ||
| nix.conf | ||
| overlay.nix | ||
| pkgs.nix | ||
| shell.nix | ||
| shells.nix | ||
| targets.nix | ||
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:
- 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.