In various Nix examples, you’ll often see references to <nixpkgs>, as follows.
{ pkgs ? import <nixpkgs> {}
}:
...
This is convenient to quickly demonstrate a Nix expression and get it working by importing Nix packages.
However, the resulting Nix expression is not fully reproducible. The <nixpkgs>
reference
is set from the local $NIX_PATH
environment variable. In most cases, this is set at the time Nix is installed
to the nixpkgs-unstable
channel, and therefore it is likely to differ from machine to machine.
Note
Channels are a way of distributing Nix software, but they are being phased out.
Even though they are still used by default, it is recommended to avoid channels
and <nixpkgs>
by always setting NIX_PATH=
to be empty.
To create fully reproducible Nix expressions, we can pin an exact versions of nixpkgs.
The simplest way to do this is to fetch the required nixpkgs version as a tarball specified via the relevant git commit hash:
{ pkgs ? import (fetchTarball "https://github.com/NixOS/nixpkgs/archive/3590f02e7d5760e52072c1a729ee2250b5560746.tar.gz") {};
}:
...
Picking the commit can be done via status.nixos.org, which lists all the releases and the latest commit that has passed all tests.
When choosing a commit, it is recommended to follow either
the latest stable NixOS release by using a specific version, such as nixos-20.03
, or
the latest unstable release via nixos-unstable
.
If you’d like a bit more automation around bumping dependencies, including nixpkgs,
niv is made for exactly that. Niv itself is available
in nixpkgs
so using it is simple:
$ nix-shell -p niv --run "niv init"
This command will generate nix/sources.json
with information about how and where
dependencies are fetched. It will also create nix/sources.nix
which glues the sources together in Nix.
By default niv
will use the latest stable NixOS release. However, you should check to see which version is currently specified in the niv repository if you require a specific release, as it might lag behind.
You can see which version niv
is tracking as follow:
$ niv show
And you can change the tracking branch to the one you want like this:
$ niv modify nixpkgs –branch nixos-20.03
You can use the generated nix/sources.nix
with a top-level default.nix
:
{ sources ? import ./nix/sources.nix
, pkgs ? import sources.nixpkgs {}
}:
...
And you can update all the dependencies by running:
$ nix-shell -p niv --run "niv update"
For more examples and details of the different ways to pin nixpkgs
, see Pinning Nixpkgs.
To quickly setup a Nix project read through Getting started Nix template.