-
Notifications
You must be signed in to change notification settings - Fork 7
/
action.yml
193 lines (177 loc) · 8.08 KB
/
action.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
name: "Cache Nix store"
description: "Restore and save Nix store using GitHub Actions cache to speed up workflows."
author: "GitHub"
inputs:
primary-key:
description: |
- When a non-empty string, the action uses this key for restoring and saving a cache.
- Otherwise, the action fails.
required: true
restore-prefixes-first-match:
description: |
- When a newline-separated non-empty list of non-empty key prefixes, when there's a miss on the `primary-key`,
the action searches in this list for the first prefix for which there exists a cache
with a matching key and the action tries to restore that cache.
- Otherwise, this input has no effect.
default: ""
restore-prefixes-all-matches:
description: |
- When a newline-separated non-empty list of non-empty key prefixes, the action tries to restore
all caches whose keys match these prefixes.
- Tries caches across all refs to make use of caches created
on the current, base, and default branches
(see [docs](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache)).
- Otherwise, this input has no effect.
default: ""
skip-restore-on-hit-primary-key:
description: |
- Can have an effect only when `restore-prefixes-first-match` has no effect.
- When `true`, when there's a hit on the `primary-key`, the action doesn't restore caches.
- Otherwise, the action restores caches.
default: "false"
fail-on:
description: |
- Input form: `<key type>.<result>`.
- `<key type>` options: `primary-key`, `first-match`.
- `<result>` options: `miss`, `not-restored`.
- When the input satisfies the input form, when the event described in the input happens, the action fails.
- Example:
- Input: `primary-key.not-restored`.
- Event: a cache could not be restored via the `primary-key`.
- Otherwise, this input has no effect.
default: ""
nix:
description: |
- Can have an effect only when the action runs on a `Linux` or a `macOS` runner.
- When `true`, the action can do Nix-specific things.
- Otherwise, the action doesn't do them.
default: "true"
save:
description: |
- When `true`, the action can save a cache with the `primary-key`.
- Otherwise, the action can't save a cache.
default: "true"
paths:
description: |
- When `nix: true`, the action uses `["/nix", "~/.cache/nix", "~root/.cache/nix"]` as default paths, as suggested [here](https://github.com/divnix/nix-cache-action/blob/b14ec98ae694c754f57f8619ea21b6ab44ccf6e7/action.yml#L7).
- Otherwise, the action uses an empty list as default paths.
- When a newline-separated non-empty list of non-empty path patterns (see [`@actions/glob`](https://github.com/actions/toolkit/tree/main/packages/glob) for supported patterns), the action appends it to default paths and uses the resulting list for restoring and saving caches.
- Otherwise, the action uses default paths for restoring and saving caches.
default: ""
paths-macos:
description: |
- Overrides `paths`.
- Can have an effect only when the action runs on a `macOS` runner.
default: ""
paths-linux:
description: |
- Overrides `paths`.
- Can have an effect only when the action runs on a `Linux` runner.
default: ""
backend:
description: |
Choose an implementation of the `cache` package.
- When `actions`, use the [actions version](https://github.com/actions/toolkit/tree/main/packages/cache) from [here](https://github.com/nix-community/cache-nix-action/tree/actions-toolkit/packages/cache).
- When `buildjet`, use the [BuildJet version](https://github.com/BuildJet/toolkit/tree/main/packages/cache-buildjet) from [here](https://github.com/nix-community/cache-nix-action/tree/buildjet-toolkit/packages/cache).
default: 'actions'
required: false
gc-max-store-size:
description: |
- Can have an effect only when `nix: true`, `save: true`.
- When a number, the action collects garbage until Nix store size (in bytes) is at most this number just before the action tries to save a new cache.
- Otherwise, this input has no effect.
default: ""
gc-max-store-size-macos:
description: |
- Overrides `gc-max-store-size`.
- Can have an effect only when the action runs on a `macOS` runner.
default: ""
gc-max-store-size-linux:
description: |
- Overrides `gc-max-store-size`.
- Can have an effect only when the action runs on a `Linux` runner.
default: ""
purge:
description: |
- When `true`, the action purges (possibly zero) caches.
- Otherwise, this input has no effect.
default: "false"
purge-primary-key:
description: |
- Can have an effect only when `purge: true`.
- When `always`, the action always purges cache with the `primary-key`.
- When `never`, the action never purges cache with the `primary-key`.
- Otherwise, this input has no effect.
default: ""
purge-prefixes:
description: |
- Can have an effect only when `purge: true`.
- When a newline-separated non-empty list of non-empty cache key prefixes, the action selects for purging all caches whose keys match some of these prefixes and that are scoped to the current [GITHUB_REF](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables).
- Otherwise, this input has no effect.
default: ""
purge-last-accessed:
description: |
- Can have an effect only when `purge: true`.
- When a non-negative number, the action purges selected caches that were last accessed more than this number of seconds ago relative to the start of the `Post Restore` phase.
- Otherwise, this input has no effect.
default: ""
purge-created:
description: |
- Can have an effect only when `purge: true`.
- When a non-negative number, the action purges selected caches that were created more than this number of seconds ago relative to the start of the `Post Restore` phase.
- Otherwise, this input has no effect.
default: ""
upload-chunk-size:
# The original default value may be provided here (https://github.com/actions/cache/issues/1292)
# 32MB
description: |
- When a non-negative number, the action uses it as the chunk size (in bytes) to split up large files during upload.
- Otherwise, the action uses the default value `33554432` (32MB).
default: ""
save-always:
description: 'Run the post step to save the cache even if another step before fails.'
default: 'false'
required: false
token:
description: |
- The action uses it to communicate with GitHub API.
- If you use a personal access token, it must have the `repo` scope ([link](https://docs.github.com/en/rest/actions/cache?apiVersion=2022-11-28#delete-github-actions-caches-for-a-repository-using-a-cache-key)).
default: ${{ github.token }}
outputs:
primary-key:
description: |
- A string.
- The `primary-key`.
hit:
description: |
- A boolean value.
- `true` when `hit-primary-key` is `true` or `hit-first-match` is `true`.
- `false` otherwise.
hit-primary-key:
description: |
- A boolean value.
- `true` when there was a hit on the `primary-key`.
- `false` otherwise.
hit-first-match:
description: |
- A boolean value.
- `true` when there was a hit on a key matching `restore-prefixes-first-match`.
- `false` otherwise.
restored-key:
description: |
- A string.
- The key of a cache restored via the `primary-key` or via the `restore-prefixes-first-match`.
- An empty string otherwise.
restored-keys:
description: |
- A possibly empty array of strings (JSON).
- Keys of restored caches.
- Example: `["key1", "key2"]`.
runs:
using: "node20"
main: "dist/restore/index.js"
post: "dist/save/index.js"
post-if: "success() || github.event.inputs.save-always"
branding:
icon: "archive"
color: "gray-dark"