Compare commits

...

8 Commits

Author SHA1 Message Date
cb6121cc54 Update README for v19 2023-02-06 15:00:46 +00:00
5c11eae19d Merge pull request #158 from cachix/fix-test
update tests
2023-02-06 14:18:48 +01:00
bd6084e16e Merge pull request #156 from InternetUnexplorer/update-readme
clarify behavior of github_access_token option
2023-02-06 07:13:26 +01:00
67388ca69e Merge pull request #157 from zimbatm/default-token
Fix rate-limits by using github.token by default
2023-02-05 18:35:04 +01:00
a4b8aaf5a2 Fix rate-limits by using github.token by default
Turns out there is a default github token we can use to talk to github
and avoid the rate limit issues.
2023-02-05 16:55:28 +01:00
70980f045d clarify behavior of github_access_token option
This also fixes a typo and makes some other tiny changes that I noticed
when I was looking at the README.
2023-01-19 16:52:32 -08:00
25d64bbf11 Merge pull request #153 from InternetUnexplorer/master
fix typo in github_access_token option
2023-01-19 19:00:25 +00:00
b95f682503 fix typo in github_access_token option
add_config only takes one argument; this was causing Nix to error with
"illegal configuration line 'access-tokens' in '/etc/nix/nix.conf'"
2023-01-07 20:10:13 -08:00
3 changed files with 16 additions and 32 deletions

View File

@ -1,24 +1,24 @@
# install-nix-action # install-nix-action
![github actions badge](https://github.com/cachix/install-nix-action/workflows/install-nix-action%20test/badge.svg) ![GitHub Actions badge](https://github.com/cachix/install-nix-action/workflows/install-nix-action%20test/badge.svg)
Installs [Nix](https://nixos.org/nix/) on GitHub Actions for the supported platforms: Linux and macOS. Installs [Nix](https://nixos.org/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 default it has no nixpkgs configured, you have to set `nix_path`
by [picking a channel](https://status.nixos.org/) by [picking a channel](https://status.nixos.org/)
or [pin nixpkgs yourself](https://nix.dev/reference/pinning-nixpkgs.html) or [pin nixpkgs yourself](https://nix.dev/reference/pinning-nixpkgs.html)
(see also [pinning tutorial](https://nix.dev/tutorials/towards-reproducibility-pinning-nixpkgs.html)). (see also [pinning tutorial](https://nix.dev/tutorials/towards-reproducibility-pinning-nixpkgs.html)).
# Features # Features
- Quick installation (~4s on Linux, ~20s on macOS) - Quick installation (~4s on Linux, ~20s on macOS)
- Multi-User installation (with sandboxing enabled only on Linux) - Multi-User installation (with sandboxing enabled only on Linux)
- [Self-hosted github runner](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) support - [Self-hosted GitHub runner](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) support
- Allows specifying Nix installation URL via `install_url` (the oldest supported Nix version is 2.3.5) - Allows specifying Nix installation URL via `install_url` (the oldest supported Nix version is 2.3.5)
- Allows specifying extra Nix configration options via `extra_nix_config` - Allows specifying extra Nix configuration options via `extra_nix_config`
- Allows specifying `$NIX_PATH` and channels via `nix_path` - Allows specifying `$NIX_PATH` and channels via `nix_path`
- Share `/nix/store` between builds using [cachix-action](https://github.com/cachix/cachix-action) for simple binary cache setup to speed up your builds and share binaries with your team - Share `/nix/store` between builds using [cachix-action](https://github.com/cachix/cachix-action) for simple binary cache setup to speed up your builds and share binaries with your team
- Enables `flakes` and `nix-command` experimental features by default (to disable, set ``experimental-features`` via ``extra_nix_config``) - Enables `flakes` and `nix-command` experimental features by default (to disable, set `experimental-features` via `extra_nix_config`)
## Usage ## Usage
@ -34,13 +34,12 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: cachix/install-nix-action@v18 - uses: cachix/install-nix-action@v19
with: with:
nix_path: nixpkgs=channel:nixos-unstable nix_path: nixpkgs=channel:nixos-unstable
- run: nix-build - run: nix-build
``` ```
## Usage with Flakes ## Usage with Flakes
```yaml ```yaml
@ -53,7 +52,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: cachix/install-nix-action@v18 - uses: cachix/install-nix-action@v19
with: with:
github_access_token: ${{ secrets.GITHUB_TOKEN }} github_access_token: ${{ secrets.GITHUB_TOKEN }}
- run: nix build - run: nix build
@ -66,11 +65,11 @@ To install Nix from any commit, go to [the corresponding installer_test action](
- `extra_nix_config`: append to `/etc/nix/nix.conf` - `extra_nix_config`: append to `/etc/nix/nix.conf`
- `github_access_token`: configure nix to pull from github using the given github token. This helps work around rate limit issues. - `github_access_token`: configure Nix to pull from GitHub using the given GitHub token. This helps work around rate limit issues. Has no effect when `access-tokens` is also specified in `extra_nix_config`.
- `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) - `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)
- `install_options`: Additional installer flags passed to the installer script. - `install_options`: additional installer flags passed to the installer script.
- `nix_path`: set `NIX_PATH` environment variable, for example `nixpkgs=channel:nixos-unstable` - `nix_path`: set `NIX_PATH` environment variable, for example `nixpkgs=channel:nixos-unstable`
@ -80,7 +79,6 @@ To install Nix from any commit, go to [the corresponding installer_test action](
### How do I print nixpkgs version I have configured? ### How do I print nixpkgs version I have configured?
```yaml ```yaml
- name: Print nixpkgs version - name: Print nixpkgs version
run: nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version' run: nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'
@ -122,26 +120,9 @@ Otherwise, you can add any binary cache to nix.conf using
install-nix-action's own `extra_nix_config` input: install-nix-action's own `extra_nix_config` input:
```yaml ```yaml
- uses: cachix/install-nix-action@v18 - uses: cachix/install-nix-action@v19
with: with:
extra_nix_config: | extra_nix_config: |
trusted-public-keys = hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= trusted-public-keys = hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
substituters = https://hydra.iohk.io https://cache.nixos.org/ substituters = https://hydra.iohk.io https://cache.nixos.org/
``` ```
## Hacking
Install the dependencies
```bash
$ yarn install
```
Build the typescript
```bash
$ yarn build
```
Run the tests :heavy_check_mark:
```bash
$ yarn test
```

View File

@ -26,3 +26,4 @@ runs:
INPUT_INSTALL_OPTIONS: ${{ inputs.install_options }} INPUT_INSTALL_OPTIONS: ${{ inputs.install_options }}
INPUT_INSTALL_URL: ${{ inputs.install_url }} INPUT_INSTALL_URL: ${{ inputs.install_url }}
INPUT_NIX_PATH: ${{ inputs.nix_path }} INPUT_NIX_PATH: ${{ inputs.nix_path }}
GITHUB_TOKEN: ${{ github.token }}

View File

@ -22,8 +22,10 @@ add_config "max-jobs = auto"
# Allow binary caches for user # Allow binary caches for user
add_config "trusted-users = root $USER" add_config "trusted-users = root $USER"
# Add github access token # Add github access token
if [[ $INPUT_GITHUB_ACCESS_TOKEN != "" ]]; then if [[ -n "${INPUT_GITHUB_ACCESS_TOKEN:-}" ]]; then
add_config "access-tokens" "github.com=$INPUT_GITHUB_ACCESS_TOKEN" add_config "access-tokens = github.com=$INPUT_GITHUB_ACCESS_TOKEN"
elif [[ -n "${GITHUB_TOKEN:-}" ]]; then
add_config "access-tokens = github.com=$GITHUB_TOKEN"
fi fi
# Append extra nix configuration if provided # Append extra nix configuration if provided
if [[ $INPUT_EXTRA_NIX_CONFIG != "" ]]; then if [[ $INPUT_EXTRA_NIX_CONFIG != "" ]]; then