Merge pull request #38 from DeterminateSystems/flakehub-cache-readme

Update readme for flakehub cache

.github/workflows/publish.yml

@@ -1,28 +0,0 @@
-name: Publish
-
-on:
-  workflow_dispatch:
-  push:
-    branches:
-      - main
-
-jobs:
-  publish:
-    name: Publish
-    runs-on: ubuntu-22.04
-    permissions:
-      contents: read
-      id-token: write
-    steps:
-      - uses: actions/checkout@v3
-      - run: |
-          mkdir artifacts
-          git archive --format=tar.gz HEAD -o ./artifacts/universal.tar.gz
-
-      - uses: DeterminateSystems/push-artifact-ids@main
-        with:
-          s3_upload_role: ${{ secrets.AWS_S3_UPLOAD_ROLE }}
-          bucket: ${{ secrets.AWS_S3_UPLOAD_BUCKET }}
-          directory: ./artifacts
-          ids_project_name: magic-nix-cache-action-priv
-          ids_binary_prefix: magic-nix-cache-action-priv

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,12 +86,13 @@ 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                               |
@@ -102,7 +106,7 @@ cat action.yml| nix run nixpkgs#yq-go -- '[[ "Parameter", "Description", "Requir
 | `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-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