cachix/cachix-action
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: format readme

Browse Source
This commit is contained in:
Sander
2025-07-04 16:01:01 +02:00
parent 3aaa65726c
commit 104f2eba33
2 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -17
View File
@@ -28,7 +28,7 @@ Follow the long-form tutorial on [Continuous Integration with GitHub Actions](ht
- uses: cachix/cachix-action@v15
with:
name: mycache
authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
```
### Write cache with signing key
@@ -37,26 +37,26 @@ Follow the long-form tutorial on [Continuous Integration with GitHub Actions](ht
- uses: cachix/cachix-action@v15
with:
name: mycache
authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
signingKey: "${{ secrets.CACHIX_SIGNING_KEY }}"
```
## Options
| Input | Description | Required | Default |
|-------|-------------|----------|---------|
| `name` | Name of a cachix cache to push and pull/substitute | ✓ | |
| `extraPullNames` | Comma-separated list of names for extra cachix caches to pull/substitute | | |
| `authToken` | Authentication token for Cachix, needed for private cache access or to push using an Auth Token | | |
| `signingKey` | Signing key secret retrieved after creating binary cache on https://cachix.org | | |
| `skipPush` | Set to true to disable pushing build results to the cache | | `false` |
| `pathsToPush` | Whitespace-separated list of paths to push. Leave empty to push every build result. | | |
| `pushFilter` | Ignored if pathsToPush is set. Regular expression to exclude derivations for the cache push, for example "(-source$|nixpkgs\.tar\.gz$)". Warning: this filter does not guarantee it will not get pushed in case the path is part of the closure of something that will get pushed. | | |
| `cachixArgs` | Extra command-line arguments to pass to cachix. If empty, defaults to -j8 | | |
| `skipAddingSubstituter` | Set to true to skip adding cachix cache as a substitute | | `false` |
| `useDaemon` | Push store paths to the cache as they're built with the Cachix Daemon | | `true` |
| `cachixBin` | Provide a custom path to the cachix binary | | |
| `installCommand` | Override the default cachix installation method | | |
| Input | Description | Required | Default |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | --- |
| `name` | Name of a cachix cache to push and pull/substitute | ✓ | |
| `extraPullNames` | Comma-separated list of names for extra cachix caches to pull/substitute | | |
| `authToken` | Authentication token for Cachix, needed for private cache access or to push using an Auth Token | | |
| `signingKey` | Signing key secret retrieved after creating binary cache on https://cachix.org | | |
| `skipPush` | Set to true to disable pushing build results to the cache | | `false` |
| `pathsToPush` | Whitespace-separated list of paths to push. Leave empty to push every build result. | | |
| `pushFilter` | Ignored if pathsToPush is set. Regular expression to exclude derivations for the cache push, for example "(-source$ | nixpkgs\.tar\.gz$)". Warning: this filter does not guarantee it will not get pushed in case the path is part of the closure of something that will get pushed. | | |
| `cachixArgs` | Extra command-line arguments to pass to cachix. If empty, defaults to -j8 | | |
| `skipAddingSubstituter` | Set to true to skip adding cachix cache as a substitute | | `false` |
| `useDaemon` | Push store paths to the cache as they're built with the Cachix Daemon | | `true` |
| `cachixBin` | Provide a custom path to the cachix binary | | |
| `installCommand` | Override the default cachix installation method | | |
## Push modes
devenv.nix
+1 -1
View File
@@ -21,7 +21,7 @@ in
git-hooks.hooks = {
prettier = {
enable = true;
files = "src/.*$";
files = "(src/.*\.ts|.*\.md)$";
};
nixfmt-rfc-style.enable = true;
build-dist = {