install-nix-action/README.md

install-nix-action

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

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.

Options with: ...

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

• nix_path: set NIX_PATH environment variable (if set skip_adding_nixpkgs_channel will be implicitly enabled)

• skip_adding_nixpkgs_channel: set to true to skip adding nixpkgs-unstable channel (and save ~5s for each job build)

• extra_nix_config: gets appended to /etc/nix/nix.conf if passed.

---

Hacking

Install the dependencies

$ yarn install

Build the typescript

$ yarn build

Run the tests ✔️

$ yarn test