Skip to content

Commit 70980f0

Browse files
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.
1 parent b95f682 commit 70980f0

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# install-nix-action
22

3-
![github actions badge](https://github.com/cachix/install-nix-action/workflows/install-nix-action%20test/badge.svg)
3+
![GitHub Actions badge](https://github.com/cachix/install-nix-action/workflows/install-nix-action%20test/badge.svg)
44

55
Installs [Nix](https://nixos.org/nix/) on GitHub Actions for the supported platforms: Linux and macOS.
66

77
By default it has no nixpkgs configured, you have to set `nix_path`
88
by [picking a channel](https://status.nixos.org/)
9-
or [pin nixpkgs yourself](https://nix.dev/reference/pinning-nixpkgs.html)
9+
or [pin nixpkgs yourself](https://nix.dev/reference/pinning-nixpkgs.html)
1010
(see also [pinning tutorial](https://nix.dev/tutorials/towards-reproducibility-pinning-nixpkgs.html)).
1111

1212
# Features
1313

1414
- Quick installation (~4s on Linux, ~20s on macOS)
1515
- Multi-User installation (with sandboxing enabled only on Linux)
16-
- [Self-hosted github runner](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) support
16+
- [Self-hosted GitHub runner](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) support
1717
- Allows specifying Nix installation URL via `install_url` (the oldest supported Nix version is 2.3.5)
18-
- Allows specifying extra Nix configration options via `extra_nix_config`
18+
- Allows specifying extra Nix configuration options via `extra_nix_config`
1919
- Allows specifying `$NIX_PATH` and channels via `nix_path`
2020
- 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
21-
- Enables `flakes` and `nix-command` experimental features by default (to disable, set ``experimental-features`` via ``extra_nix_config``)
21+
- Enables `flakes` and `nix-command` experimental features by default (to disable, set `experimental-features` via `extra_nix_config`)
2222

2323
## Usage
2424

@@ -40,7 +40,6 @@ jobs:
4040
- run: nix-build
4141
```
4242
43-
4443
## Usage with Flakes
4544
4645
```yaml
@@ -66,11 +65,11 @@ To install Nix from any commit, go to [the corresponding installer_test action](
6665

6766
- `extra_nix_config`: append to `/etc/nix/nix.conf`
6867

69-
- `github_access_token`: configure nix to pull from github using the given github token. This helps work around rate limit issues.
68+
- `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`.
7069

71-
- `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)
70+
- `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)
7271

73-
- `install_options`: Additional installer flags passed to the installer script.
72+
- `install_options`: additional installer flags passed to the installer script.
7473

7574
- `nix_path`: set `NIX_PATH` environment variable, for example `nixpkgs=channel:nixos-unstable`
7675

@@ -80,7 +79,6 @@ To install Nix from any commit, go to [the corresponding installer_test action](
8079

8180
### How do I print nixpkgs version I have configured?
8281

83-
8482
```yaml
8583
- name: Print nixpkgs version
8684
run: nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'
@@ -132,16 +130,19 @@ install-nix-action's own `extra_nix_config` input:
132130
## Hacking
133131
134132
Install the dependencies
133+
135134
```bash
136135
$ yarn install
137136
```
138137

139138
Build the typescript
139+
140140
```bash
141141
$ yarn build
142142
```
143143

144144
Run the tests :heavy_check_mark:
145+
145146
```bash
146147
$ yarn test
147148
```

0 commit comments

Comments
 (0)