mirror of
https://github.com/DeterminateSystems/magic-nix-cache-action.git
synced 2024-12-23 13:32:03 +01:00
Update readme for flakehub cache
This commit is contained in:
Graham Christensen
parent
122e91d346
commit
b505f491cf
1 changed files with 22 additions and 18 deletions
40
README.md
40
README.md
|
|
@ -41,6 +41,9 @@ on:
|
|||
jobs:
|
||||
check:
|
||||
runs-on: ubuntu-22.04
|
||||
permissions:
|
||||
id-token: "write"
|
||||
contents: "read"
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: DeterminateSystems/nix-installer-action@main
|
||||
|
|
@ -73,7 +76,7 @@ When the rate limit is exceeded while uploading to the cache, the remainder of t
|
|||
|
||||
### Upstream cache
|
||||
|
||||
When you configure an upstream cache for the Magic Nix Cache, any store paths fetched from that source are *not* cached because they are known to be fetchable on future workflow runs.
|
||||
When you configure an upstream cache for the Magic Nix Cache, any store paths fetched from that source are _not_ cached because they are known to be fetchable on future workflow runs.
|
||||
The default is `https://cache.nixos.org` but you can set a different upstream:
|
||||
|
||||
```yaml
|
||||
|
|
@ -83,27 +86,28 @@ The default is `https://cache.nixos.org` but you can set a different upstream:
|
|||
```
|
||||
|
||||
## Action Options
|
||||
|
||||
<!--
|
||||
cat action.yml| nix run nixpkgs#yq-go -- '[[ "Parameter", "Description", "Required", "Default" ], ["-", "-", "-", "-"]] + [.inputs | to_entries | sort_by(.key) | .[] | ["`" + .key + "`", .value.description, .value.required // "", .value.default // ""]] | map(join(" | ")) | .[] | "| " + . + " |"' -r
|
||||
-->
|
||||
|
||||
| Parameter | Description | Required | Default |
|
||||
| - | - | - | - |
|
||||
| `diagnostic-endpoint` | Diagnostic endpoint url where diagnostics and performance data is sent. To disable set this to an empty string. | | https://install.determinate.systems/magic-nix-cache/perf |
|
||||
| `flakehub-api-server` | The FlakeHub API server. | | https://api.flakehub.com |
|
||||
| `flakehub-cache-server` | The FlakeHub binary cache server. | | https://cache.flakehub.com |
|
||||
| `flakehub-flake-name` | The name of your flake on FlakeHub. Defaults to the current name of the GitHub repository it is running in. | | |
|
||||
| `listen` | The host and port to listen on. | | 127.0.0.1:37515 |
|
||||
| `source-binary` | Run a version of the cache binary from somewhere already on disk. Conflicts with all other `source-*` options. | | |
|
||||
| `source-branch` | The branch of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | main |
|
||||
| `source-pr` | The PR of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
|
||||
| `source-revision` | The revision of `nix-magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
|
||||
| `source-tag` | The tag of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
|
||||
| `source-url` | A URL pointing to a `magic-nix-cache` binary. Overrides all other `source-*` options. | | |
|
||||
| `startup-notification-port` | The port magic-nix-cache uses for daemon startup notification. | | 41239 |
|
||||
| `upstream-cache` | Your preferred upstream cache. Store paths in this store will not be cached in GitHub Actions' cache. | | https://cache.nixos.org |
|
||||
| `use-flakehub` | Whether to upload build results to FlakeHub Cache. | | true |
|
||||
| `use-gha-cache` | Whether to upload build results to the GitHub Actions cache. | | true |
|
||||
| Parameter | Description | Required | Default |
|
||||
| --------------------------- | --------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------- |
|
||||
| `diagnostic-endpoint` | Diagnostic endpoint url where diagnostics and performance data is sent. To disable set this to an empty string. | | https://install.determinate.systems/magic-nix-cache/perf |
|
||||
| `flakehub-api-server` | The FlakeHub API server. | | https://api.flakehub.com |
|
||||
| `flakehub-cache-server` | The FlakeHub binary cache server. | | https://cache.flakehub.com |
|
||||
| `flakehub-flake-name` | The name of your flake on FlakeHub. Defaults to the current name of the GitHub repository it is running in. | | |
|
||||
| `listen` | The host and port to listen on. | | 127.0.0.1:37515 |
|
||||
| `source-binary` | Run a version of the cache binary from somewhere already on disk. Conflicts with all other `source-*` options. | | |
|
||||
| `source-branch` | The branch of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | main |
|
||||
| `source-pr` | The PR of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
|
||||
| `source-revision` | The revision of `nix-magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
|
||||
| `source-tag` | The tag of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
|
||||
| `source-url` | A URL pointing to a `magic-nix-cache` binary. Overrides all other `source-*` options. | | |
|
||||
| `startup-notification-port` | The port magic-nix-cache uses for daemon startup notification. | | 41239 |
|
||||
| `upstream-cache` | Your preferred upstream cache. Store paths in this store will not be cached in GitHub Actions' cache. | | https://cache.nixos.org |
|
||||
| `use-flakehub` | Whether to upload build results to FlakeHub Cache (private beta). | | true |
|
||||
| `use-gha-cache` | Whether to upload build results to the GitHub Actions cache. | | true |
|
||||
|
||||
[gha-cache]: https://docs.github.com/en/rest/actions/cache
|
||||
[detsys]: https://determinate.systems/
|
||||
|
|
|
|||
Loading…
Reference in a new issue