Merge pull request #158 from cachix/fix-test

update tests

.github/workflows/test.yml

@@ -61,11 +61,6 @@ jobs:
     - uses: actions/checkout@v3
     - name: Install Nix
       uses: ./
-      with:
-        install_url: https://nixos-nix-install-tests.cachix.org/serve/i6laym9jw3wg9mw6ncyrk6gjx4l34vvx/install
-        install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve'
-        extra_nix_config: |
-          access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
     - run: nix flake show github:NixOS/nixpkgs
 
   installer-options:
@@ -78,9 +73,9 @@ jobs:
     - name: Install Nix
       uses: ./
       with:
-        nix_path: nixpkgs=channel:nixos-21.05
-        install_url: https://nixos-nix-install-tests.cachix.org/serve/i6laym9jw3wg9mw6ncyrk6gjx4l34vvx/install
-        install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve'
+        nix_path: nixpkgs=channel:nixos-22.05
+        install_options: --tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve
+        install_url: https://nixos-nix-install-tests.cachix.org/serve/s62m7lc0q0mz2mxxm9q0kkrcg90njzhq/install
     - run: nix-build test.nix
 
   oldest-supported-installer:
@@ -93,8 +88,8 @@ jobs:
     - name: Install Nix
       uses: ./
       with:
-        nix_path: nixpkgs=channel:nixos-21.05
-        install_url: https://releases.nixos.org/nix/nix-2.3.8/install
+        nix_path: nixpkgs=channel:nixos-22.05
+        install_url: https://releases.nixos.org/nix/nix-2.8.0/install
     - run: nix-build test.nix
 
   act-support:

README.md

@@ -1,24 +1,24 @@
 # 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.
 
 By default it has no nixpkgs configured, you have to set `nix_path`
 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)).
 
 # Features
 
 - Quick installation (~4s on Linux, ~20s on macOS)
 - 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 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`
 - 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
 
@@ -34,13 +34,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: cachix/install-nix-action@v17
+    - uses: cachix/install-nix-action@v18
       with:
         nix_path: nixpkgs=channel:nixos-unstable
     - run: nix-build
 ```
 
-
 ## Usage with Flakes
 
 ```yaml
@@ -53,10 +52,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: cachix/install-nix-action@v17
+    - uses: cachix/install-nix-action@v18
       with:
-        extra_nix_config: |
-          access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
+        github_access_token: ${{ secrets.GITHUB_TOKEN }}
     - run: nix build
     - run: nix flake check
 ```
@@ -65,19 +63,22 @@ To install Nix from any commit, go to [the corresponding installer_test action](
 
 ## 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)
+- `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. 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_options`: additional installer flags passed to the installer script.
 
 - `nix_path`: set `NIX_PATH` environment variable, for example `nixpkgs=channel:nixos-unstable`
 
-- `extra_nix_config`: append to `/etc/nix/nix.conf`
-
 ---
 
 ## FAQ
 
 ### How do I print nixpkgs version I have configured?
 
-
 ```yaml
 - name: Print nixpkgs version
   run: nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'
@@ -119,7 +120,7 @@ Otherwise, you can add any binary cache to nix.conf using
 install-nix-action's own `extra_nix_config` input:
 
 ```yaml
-- uses: cachix/install-nix-action@vXX
+- uses: cachix/install-nix-action@v18
   with:
     extra_nix_config: |
       trusted-public-keys = hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
@@ -129,16 +130,19 @@ install-nix-action's own `extra_nix_config` input:
 ## Hacking
 
 Install the dependencies
+
 ```bash
 $ yarn install
 ```
 
 Build the typescript
+
 ```bash
 $ yarn build
 ```
 
 Run the tests :heavy_check_mark:
+
 ```bash
 $ yarn test
 ```

action.yml

@@ -2,14 +2,16 @@ name: 'Install Nix'
 description: 'Installs Nix on GitHub Actions for the supported platforms: Linux and macOS.'
 author: 'Domen Kožar'
 inputs:
+  extra_nix_config:
+    description: 'Gets appended to `/etc/nix/nix.conf` if passed.'
+  github_access_token:
+    description: 'Configure nix to pull from github using the given github token.'
   install_url:
     description: 'Installation URL that will contain a script to install Nix.'
   install_options:
     description: 'Additional installer flags passed to the installer script.'
   nix_path:
     description: 'Set NIX_PATH environment variable.'
-  extra_nix_config:
-    description: 'gets appended to `/etc/nix/nix.conf` if passed.'
 branding:
   color: 'blue'
   icon: 'sun'
@@ -19,7 +21,9 @@ runs:
     - run : ${{ github.action_path }}/install-nix.sh
       shell: bash
       env:
-        INPUT_INSTALL_URL: ${{ inputs.install_url }}
-        INPUT_INSTALL_OPTIONS: ${{ inputs.install_options }}
-        INPUT_NIX_PATH: ${{ inputs.nix_path }}
         INPUT_EXTRA_NIX_CONFIG: ${{ inputs.extra_nix_config }}
+        INPUT_GITHUB_ACCESS_TOKEN: ${{ inputs.github_access_token }}
+        INPUT_INSTALL_OPTIONS: ${{ inputs.install_options }}
+        INPUT_INSTALL_URL: ${{ inputs.install_url }}
+        INPUT_NIX_PATH: ${{ inputs.nix_path }}
+        GITHUB_TOKEN: ${{ github.token }}

install-nix.sh

@@ -21,6 +21,12 @@ add_config() {
 add_config "max-jobs = auto"
 # Allow binary caches for user
 add_config "trusted-users = root $USER"
+# Add github access token
+if [[ -n "${INPUT_GITHUB_ACCESS_TOKEN:-}" ]]; then
+  add_config "access-tokens = github.com=$INPUT_GITHUB_ACCESS_TOKEN"
+elif [[ -n "${GITHUB_TOKEN:-}" ]]; then
+  add_config "access-tokens = github.com=$GITHUB_TOKEN"
+fi
 # Append extra nix configuration if provided
 if [[ $INPUT_EXTRA_NIX_CONFIG != "" ]]; then
   add_config "$INPUT_EXTRA_NIX_CONFIG"
@@ -37,7 +43,7 @@ installer_options=(
 )
 
 # only use the nix-daemon settings if on darwin (which get ignored) or systemd is supported
-if [[ $OSTYPE =~ darwin || -e /run/systemd/system ]]; then
+if [[ (! $INPUT_INSTALL_OPTIONS =~ "--no-daemon") && ($OSTYPE =~ darwin || -e /run/systemd/system) ]]; then
   installer_options+=(
     --daemon
     --daemon-user-count "$(python3 -c 'import multiprocessing as mp; print(mp.cpu_count() * 2)')"