Skip to content

Commit fc6aace

Browse files
grahamcgrahamc
authored
Merge pull request #38 from DeterminateSystems/flakehub-cache-readme
Update readme for flakehub cache
2 parents 122e91d + f7df689 commit fc6aace

File tree

2 files changed

+22
-46
lines changed

2 files changed

+22
-46
lines changed

‎.github/workflows/publish.yml‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎README.md‎

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ on:
4141
jobs:
4242
check:
4343
runs-on: ubuntu-22.04
44+
permissions:
45+
id-token: "write"
46+
contents: "read"
4447
steps:
4548
- uses: actions/checkout@v3
4649
- 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
7376
7477
### Upstream cache
7578
76-
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.
79+
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.
7780
The default is `https://cache.nixos.org` but you can set a different upstream:
7881

7982
```yaml
@@ -83,27 +86,28 @@ The default is `https://cache.nixos.org` but you can set a different upstream:
8386
```
8487

8588
## Action Options
89+
8690
<!--
8791
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
8892
-->
8993

90-
| Parameter | Description | Required | Default |
91-
| - | - | - | - |
92-
| `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 |
93-
| `flakehub-api-server` | The FlakeHub API server. | | https://api.flakehub.com |
94-
| `flakehub-cache-server` | The FlakeHub binary cache server. | | https://cache.flakehub.com |
95-
| `flakehub-flake-name` | The name of your flake on FlakeHub. Defaults to the current name of the GitHub repository it is running in. | | |
96-
| `listen` | The host and port to listen on. | | 127.0.0.1:37515 |
97-
| `source-binary` | Run a version of the cache binary from somewhere already on disk. Conflicts with all other `source-*` options. | | |
98-
| `source-branch` | The branch of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | main |
99-
| `source-pr` | The PR of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
100-
| `source-revision` | The revision of `nix-magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
101-
| `source-tag` | The tag of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
102-
| `source-url` | A URL pointing to a `magic-nix-cache` binary. Overrides all other `source-*` options. | | |
103-
| `startup-notification-port` | The port magic-nix-cache uses for daemon startup notification. | | 41239 |
104-
| `upstream-cache` | Your preferred upstream cache. Store paths in this store will not be cached in GitHub Actions' cache. | | https://cache.nixos.org |
105-
| `use-flakehub` | Whether to upload build results to FlakeHub Cache. | | true |
106-
| `use-gha-cache` | Whether to upload build results to the GitHub Actions cache. | | true |
94+
| Parameter | Description | Required | Default |
95+
| --------------------------- | --------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------- |
96+
| `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 |
97+
| `flakehub-api-server` | The FlakeHub API server. | | https://api.flakehub.com |
98+
| `flakehub-cache-server` | The FlakeHub binary cache server. | | https://cache.flakehub.com |
99+
| `flakehub-flake-name` | The name of your flake on FlakeHub. Defaults to the current name of the GitHub repository it is running in. | | |
100+
| `listen` | The host and port to listen on. | | 127.0.0.1:37515 |
101+
| `source-binary` | Run a version of the cache binary from somewhere already on disk. Conflicts with all other `source-*` options. | | |
102+
| `source-branch` | The branch of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | main |
103+
| `source-pr` | The PR of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
104+
| `source-revision` | The revision of `nix-magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
105+
| `source-tag` | The tag of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
106+
| `source-url` | A URL pointing to a `magic-nix-cache` binary. Overrides all other `source-*` options. | | |
107+
| `startup-notification-port` | The port magic-nix-cache uses for daemon startup notification. | | 41239 |
108+
| `upstream-cache` | Your preferred upstream cache. Store paths in this store will not be cached in GitHub Actions' cache. | | https://cache.nixos.org |
109+
| `use-flakehub` | Whether to upload build results to FlakeHub Cache (private beta). | | true |
110+
| `use-gha-cache` | Whether to upload build results to the GitHub Actions cache. | | true |
107111

108112
[gha-cache]: https://docs.github.com/en/rest/actions/cache
109113
[detsys]: https://determinate.systems/

0 commit comments

Comments
 (0)