install-nix-action/README.md

47 lines
864 B
Markdown
Raw Permalink Normal View History

2019-10-02 14:06:28 +00:00
# install-nix-action
2019-09-29 19:52:02 +00:00
2019-10-02 14:06:28 +00:00
![github actions badge](https://github.com/cachix/install-nix-action/workflows/install-nix-action%20test/badge.svg)
2019-09-29 19:52:02 +00:00
2019-10-02 13:36:51 +00:00
Installs [Nix](https://nixos.org/nix/) on GitHub Actions for the supported platforms: Linux and macOS.
2019-09-29 19:52:02 +00: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:
- uses: actions/checkout@v1
2019-10-02 15:38:01 +00:00
- uses: cachix/install-nix-action@v2
2019-09-29 19:52:02 +00:00
- run: nix-build
```
See also [cachix-action](https://github.com/cachix/cachix-action) for
2019-10-02 14:06:28 +00:00
simple binary cache setup to speed up your builds and share binaries
with developers.
2019-09-29 19:52:02 +00:00
---
## Hacking
2019-10-02 13:36:51 +00:00
Install the dependencies
2019-09-29 19:52:02 +00:00
```bash
$ yarn install
```
Build the typescript
```bash
$ yarn build
```
2019-10-02 13:36:51 +00:00
Run the tests :heavy_check_mark:
2019-09-29 19:52:02 +00:00
```bash
$ yarn test
```