2019-10-03 00:06:28 +10:00
# install-nix-action
2019-09-30 05:52:02 +10:00
2019-10-03 00:06:28 +10:00
![github actions badge ](https://github.com/cachix/install-nix-action/workflows/install-nix-action%20test/badge.svg )
2019-09-30 05:52:02 +10:00
2019-10-02 23:36:51 +10:00
Installs [Nix ](https://nixos.org/nix/ ) on GitHub Actions for the supported platforms: Linux and macOS.
2019-09-30 05:52:02 +10:00
2020-09-21 23:00:28 +10:00
By default it has no nixpkgs configured, you have to set `nix_path`
2020-09-21 22:37:56 +10:00
by [picking a channel ](https://status.nixos.org/ )
or [pin nixpkgs yourself ](https://nix.dev/tutorials/towards-reproducibility-pinning-nixpkgs.html ).
2020-09-21 21:51:23 +10:00
# Features
- Quick installation (~4s on Linux, ~20s on macOS)
2020-09-21 23:00:28 +10:00
- Multi-User installation (with sandboxing enabled only on Linux)
2020-09-21 21:51:23 +10:00
- [Self-hosted github runner ](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners ) support
2020-09-21 23:00:28 +10:00
- 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`
2020-09-21 21:51:23 +10:00
2019-09-30 05:52:02 +10:00
## Usage
Create `.github/workflows/test.yml` in your repo with the following contents:
```yaml
name: "Test"
on:
pull_request:
push:
jobs:
tests:
runs-on: ubuntu-latest
steps:
2020-03-01 21:47:40 +11:00
- uses: actions/checkout@v2
2020-09-21 23:16:33 +10:00
- uses: cachix/install-nix-action@v11
2020-05-29 00:25:05 +10:00
with:
nix_path: nixpkgs=channel:nixos-unstable
2019-09-30 05:52:02 +10:00
- run: nix-build
```
See also [cachix-action ](https://github.com/cachix/cachix-action ) for
2019-10-03 00:06:28 +10:00
simple binary cache setup to speed up your builds and share binaries
with developers.
2019-09-30 05:52:02 +10:00
2020-09-21 23:00:53 +10:00
## Usage with Flakes
2020-09-21 21:51:23 +10:00
2020-09-22 00:25:56 +10:00
```yaml
2020-09-21 21:51:23 +10:00
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:`)
2020-05-28 00:59:17 +10:00
2020-09-21 21:51:23 +10:00
- `install_url` : specify URL to install Nix from (useful for testing non-stable releases)
2020-05-29 00:25:05 +10:00
2020-09-21 21:51:23 +10:00
- `nix_path` : set `NIX_PATH` environment variable, for example `nixpkgs=channel:nixos-unstable`
2020-05-28 00:59:17 +10:00
2020-09-21 21:51:23 +10:00
- `extra_nix_config` : append to `/etc/nix/nix.conf`
2020-05-28 00:59:17 +10:00
2019-09-30 05:52:02 +10:00
---
2020-09-21 23:10:35 +10:00
## 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 ](https://github.com/actions/virtual-environments/issues/183#issuecomment-610723516 ).
2020-09-21 23:12:38 +10:00
### How do I print nixpkgs version with the channel I have configured?
```nix-instantiate --eval -E '(import < nixpkgs > {}).lib.version'```
2019-09-30 05:52:02 +10:00
## Hacking
2019-10-02 23:36:51 +10:00
Install the dependencies
2019-09-30 05:52:02 +10:00
```bash
$ yarn install
```
Build the typescript
```bash
$ yarn build
```
2019-10-02 23:36:51 +10:00
Run the tests :heavy_check_mark:
2019-09-30 05:52:02 +10:00
```bash
$ yarn test
```