https://github.com/zombiezen/setup-nix-cache-action

GitHub Action that configures Nix to read/write to a cache
https://github.com/zombiezen/setup-nix-cache-action

build-cache github-actions nix nixpkgs

Last synced: 6 days ago
JSON representation

GitHub Action that configures Nix to read/write to a cache

• Host: GitHub
• URL: https://github.com/zombiezen/setup-nix-cache-action
• Owner: zombiezen
• License: apache-2.0
• Created: 2022-01-07T02:08:59.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-23T16:00:09.000Z (10 days ago)
• Last Synced: 2024-09-24T01:05:06.717Z (10 days ago)
• Topics: build-cache, github-actions, nix, nixpkgs
• Language: TypeScript
• Homepage:
• Size: 1.55 MB
• Stars: 14
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Set up Nix Cache Action

This is a [GitHub Action][] that configures the [Nix][] package manager

to read from (and optionally write to)

a remote cache.

[GitHub Action]: https://docs.github.com/en/actions

[Nix]: https://nixos.org/

## Usage

Using an [Amazon Web Services S3][] bucket for loading and storing:

```yaml

name: Build

jobs:

  build:

    name: Build

    runs-on: ubuntu-latest

    steps:

    - name: Check out code

      uses: actions/checkout@v4

    - name: Install Nix

      uses: cachix/install-nix-action@v23

    - name: Set up cache

      uses: zombiezen/[email protected]

      with:

        substituters: s3://example-bucket

        secret_keys: ${{ secrets.NIX_PRIVATE_KEY }}

        aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}

        aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

    - name: Build

      run: nix-build

```

Using a [Google Cloud Storage][] bucket for loading and storing:

```yaml

name: Build

jobs:

  build:

    name: Build

    runs-on: ubuntu-latest

    steps:

    - name: Check out code

      uses: actions/checkout@v4

    - name: Install Nix

      uses: cachix/install-nix-action@v23

    - name: Authenticate to Google Cloud Platform

      # See https://github.com/google-github-actions/auth/blob/main/README.md

      # for details on how to set up.

      uses: google-github-actions/auth@v1

    - name: Set up cache

      uses: zombiezen/[email protected]

      with:

        substituters: gs://example-bucket

        secret_keys: ${{ secrets.NIX_PRIVATE_KEY }}

        use_nixcached: true

    - name: Build

      run: nix-build

```

The example above uses [nixcached][] to connect to Google Cloud Storage

using normal service account credentials.

If you prefer to avoid the dependency, you can instead use the [interoperability endpoint][],

but you will have to generate an HMAC key:

```yaml

# Connecting to GCS without nixcached (not recommended).

name: Build

jobs:

  build:

    name: Build

    runs-on: ubuntu-latest

    steps:

    - name: Check out code

      uses: actions/checkout@v4

    - name: Install Nix

      uses: cachix/install-nix-action@v23

    - name: Set up cache

      uses: zombiezen/[email protected]

      with:

        substituters: s3://example-bucket?endpoint=https://storage.googleapis.com

        secret_keys: ${{ secrets.NIX_PRIVATE_KEY }}

        aws_access_key_id: ${{ secrets.GCS_HMAC_ACCESS_ID }}

        aws_secret_access_key: ${{ secrets.GCS_HMAC_SECRET_ACCESS_KEY }}

    - name: Build

      run: nix-build

```

[Amazon Web Services S3]: https://aws.amazon.com/s3/

[Google Cloud Storage]: https://cloud.google.com/storage

[interoperability endpoint]: https://cloud.google.com/storage/docs/interoperability

[nixcached]: https://github.com/zombiezen/nixcached

## Inputs

### `substituters`

(Required) One or more space-separated cache URLs (typically starts with `s3://`)

### `trusted_public_keys`

Space-separated trusted keys for signed downloads.

Not required if a private key is given.

### `secret_keys`

Private keys for signing built artifacts.

If provided, built derivations will be uploaded to the first substituter.

### `aws_access_key_id`

Access key ID for downloading and uploading artifacts

### `aws_secret_access_key`

Secret access key for downloading and uploading artifacts

### `use_nixcached`

If `true`, use [nixcached][] for uploading and downloading.

This permits concurrent uploading and more straightforward authentication.

### `nixcached_upload_options`

Additional arguments to send to `nixcached upload`.

POSIX-shell-style quoting is supported.

## License

[Apache 2.0](LICENSE)