NixiN/install-nix-action
2
0
Fork 0
mirror of https://github.com/cachix/install-nix-action.git synced 2024-11-21 16:10:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Installs Nix on GitHub Actions for the supported platforms: Linux and macOS.
83 commits 51 branches 32 tags 17 MiB
Shell 90.4%
Nix 9.6%
Find a file
Domen Kožar e583e9458b
test
2020-09-28 21:55:27 +02:00
.github test 2020-09-28 21:55:27 +02:00
__tests__ Initial commit 2019-10-02 11:52:32 +02:00
lib Update lib/install-nix.sh 2020-09-21 14:30:19 +02:00
src Prepare for Nix 2.3.5 2020-05-26 18:08:30 +02:00
.gitignore Initial commit 2019-10-02 11:52:32 +02:00
action.yml Support self-hosted runners and always skip adding a channel 2020-09-21 14:16:30 +02:00
jest.config.js Initial commit 2019-10-02 11:52:32 +02:00
LICENSE Initial commit 2019-10-02 11:52:32 +02:00
package.json rename to install-nix-action 2019-10-02 16:06:28 +02:00
README.md README: mention why install_url is useful 2020-09-21 18:54:24 +02:00
shell.nix add shell.nix for easier development 2019-11-07 10:19:07 +01:00
test.nix add failing test 2020-08-25 18:17:09 +02:00
tsconfig.json Initial commit 2019-10-02 11:52:32 +02:00
yarn.lock Bump handlebars from 4.4.0 to 4.7.6 2020-09-07 12:01:35 +00:00

README.md

install-nix-action

github actions badge

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

By default it has no nixpkgs 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 installation (with sandboxing enabled only on Linux)
  • Self-hosted github runner support
  • Allows specifying Nix installation URL via install_url
  • Allows specifying extra Nix configration options via extra_nix_config
  • Allows specifying $NIX_PATH and channels via nix_path

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@v11
      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 or pinning Nix for example https://releases.nixos.org/nix/nix-2.3.7/install)

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

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

FAQ

Is it possible to run NixOS tests / Qemu+KVM with GitHub Actions?

Currently GitHub Actions are not running on Azure instance types that support nested virtualization.

How do I print nixpkgs version with the channel I have configured?

nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'

Hacking

Install the dependencies

$ yarn install

Build the typescript

$ yarn build

Run the tests ✔️

$ yarn test