install-nix-action

Installs Nix on GitHub Actions for the supported platforms: Linux and macOS.

By default it has no channels configured, you have to set nix_path by picking a channel or pin nixpkgs yourself.

Features

• Quick installation (~4s on Linux, ~20s on macOS)
• Multi-User mode with sandboxing enabled on Linux
• Self-hosted github runner support
• Allows specifying Nix installation URL
• Allows specifying extra Nix configration options
• Allows specifying $NIX_PATH and channels

Usage

Create .github/workflows/test.yml in your repo with the following contents:

name: "Test"
on:
  pull_request:
  push:
jobs:
  tests:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: cachix/install-nix-action@v10
      with:
        nix_path: nixpkgs=channel:nixos-unstable
    - run: nix-build

See also cachix-action for simple binary cache setup to speed up your builds and share binaries with developers.

Usage with Flakes

name: "Test"
on:
  pull_request:
  push:
jobs:
  tests:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
      with:
          # Nix Flakes doesn't work on shallow clones
          fetch-depth: 0
    - uses: cachix/install-nix-action@v11
      with:
        install_url: https://github.com/numtide/nix-flakes-installer/releases/download/nix-3.0pre20200820_4d77513/install
        extra_nix_config: |
          experimental-features = nix-command flakes
    - run: nix-build

Inputs (specify using with:)

• install_url: specify URL to install Nix from (useful for testing non-stable releases)

• nix_path: set NIX_PATH environment variable, for example nixpkgs=channel:nixos-unstable

• extra_nix_config: append to /etc/nix/nix.conf

---

Hacking

Install the dependencies

$ yarn install

Build the typescript

$ yarn build

Run the tests ✔️

$ yarn test