diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml deleted file mode 100644 index d14ce55..0000000 --- a/.github/workflows/publish.yml +++ /dev/null @@ -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 diff --git a/README.md b/README.md index c5f4ec7..ac09c34 100644 --- a/README.md +++ b/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 + -| 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/