Skip to content

Commit 61d2f57

Browse files
deempdeemp
committed
fix(action): write that outputs are stringy booleans
1 parent d3c58ae commit 61d2f57

File tree

5 files changed

+43
-43
lines changed

5 files changed

+43
-43
lines changed

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,14 @@ See [action.yml](action.yml).
139139

140140
## Outputs
141141

142-
| name | description |
143-
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
144-
| `primary-key` | <ul> <li>A string.</li> <li>The <code>primary-key</code>.</li> </ul> |
145-
| `hit` | <ul> <li>A boolean value.</li> <li><code>true</code> when <code>hit-primary-key</code> is <code>true</code> or <code>hit-first-match</code> is <code>true</code>.</li> <li><code>false</code> otherwise.</li> </ul> |
146-
| `hit-primary-key` | <ul> <li>A boolean value.</li> <li><code>true</code> when there was a hit on the <code>primary-key</code>.</li> <li><code>false</code> otherwise.</li> </ul> |
147-
| `hit-first-match` | <ul> <li>A boolean value.</li> <li><code>true</code> when there was a hit on a key matching <code>restore-prefixes-first-match</code>.</li> <li><code>false</code> otherwise.</li> </ul> |
148-
| `restored-key` | <ul> <li>A string.</li> <li>The key of a cache restored via the <code>primary-key</code> or via the <code>restore-prefixes-first-match</code>.</li> <li>An empty string otherwise.</li> </ul> |
149-
| `restored-keys` | <ul> <li>A possibly empty array of strings (JSON).</li> <li>Keys of restored caches.</li> <li>Example: <code>["key1", "key2"]</code>.</li> </ul> |
142+
| name | description |
143+
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
144+
| `primary-key` | <ul> <li>A string.</li> <li>The <code>primary-key</code>.</li> </ul> |
145+
| `hit` | <ul> <li>A boolean string.</li> <li><code>'true'</code> when <code>hit-primary-key</code> is <code>true</code> or <code>hit-first-match</code> is <code>true</code>.</li> <li><code>'false'</code> otherwise.</li> </ul> |
146+
| `hit-primary-key` | <ul> <li>A boolean string.</li> <li><code>'true'</code> when there was a hit on the <code>primary-key</code>.</li> <li><code>'false'</code> otherwise.</li> </ul> |
147+
| `hit-first-match` | <ul> <li>A boolean string.</li> <li><code>'true'</code> when there was a hit on a key matching <code>restore-prefixes-first-match</code>.</li> <li><code>'false'</code> otherwise.</li> </ul> |
148+
| `restored-key` | <ul> <li>A string.</li> <li>The key of a cache restored via the <code>primary-key</code> or via the <code>restore-prefixes-first-match</code>.</li> <li>An empty string otherwise.</li> </ul> |
149+
| `restored-keys` | <ul> <li>A possibly empty array of strings (JSON).</li> <li>Keys of restored caches.</li> <li>Example: <code>["key1", "key2"]</code>.</li> </ul> |
150150

151151
<!-- action-docs-outputs action="action.yml" -->
152152

‎action.nix‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -233,19 +233,19 @@ in
233233
234234
hit:
235235
description: |
236-
- A boolean value.
237-
- `true` when ${q hit-primary-key} is `true` or ${q hit-first-match} is `true`.
238-
- `false` otherwise.
236+
- A boolean string.
237+
- `'true'` when ${q hit-primary-key} is `true` or ${q hit-first-match} is `true`.
238+
- `'false'` otherwise.
239239
${hit-primary-key}:
240240
description: |
241-
- A boolean value.
242-
- `true` when there was a hit on the ${q primary-key}.
243-
- `false` otherwise.
241+
- A boolean string.
242+
- `'true'` when there was a hit on the ${q primary-key}.
243+
- `'false'` otherwise.
244244
${hit-first-match}:
245245
description: |
246-
- A boolean value.
247-
- `true` when there was a hit on a key matching ${q restore-prefixes-first-match}.
248-
- `false` otherwise.
246+
- A boolean string.
247+
- `'true'` when there was a hit on a key matching ${q restore-prefixes-first-match}.
248+
- `'false'` otherwise.
249249
250250
restored-key:
251251
description: |

‎action.yml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -154,19 +154,19 @@ outputs:
154154
155155
hit:
156156
description: |
157-
- A boolean value.
158-
- `true` when `hit-primary-key` is `true` or `hit-first-match` is `true`.
159-
- `false` otherwise.
157+
- A boolean string.
158+
- `'true'` when `hit-primary-key` is `true` or `hit-first-match` is `true`.
159+
- `'false'` otherwise.
160160
hit-primary-key:
161161
description: |
162-
- A boolean value.
163-
- `true` when there was a hit on the `primary-key`.
164-
- `false` otherwise.
162+
- A boolean string.
163+
- `'true'` when there was a hit on the `primary-key`.
164+
- `'false'` otherwise.
165165
hit-first-match:
166166
description: |
167-
- A boolean value.
168-
- `true` when there was a hit on a key matching `restore-prefixes-first-match`.
169-
- `false` otherwise.
167+
- A boolean string.
168+
- `'true'` when there was a hit on a key matching `restore-prefixes-first-match`.
169+
- `'false'` otherwise.
170170
171171
restored-key:
172172
description: |

‎restore/README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ The restore action restores a cache. It works similarly to the `cache` action ex
2929

3030
## Outputs
3131

32-
| name | description |
33-
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34-
| `primary-key` | <ul> <li>A string.</li> <li>The <code>primary-key</code>.</li> </ul> |
35-
| `hit` | <ul> <li>A boolean value.</li> <li><code>true</code> when <code>hit-primary-key</code> is <code>true</code> or <code>hit-first-match</code> is <code>true</code>.</li> <li><code>false</code> otherwise.</li> </ul> |
36-
| `hit-primary-key` | <ul> <li>A boolean value.</li> <li><code>true</code> when there was a hit on the <code>primary-key</code>.</li> <li><code>false</code> otherwise.</li> </ul> |
37-
| `hit-first-match` | <ul> <li>A boolean value.</li> <li><code>true</code> when there was a hit on a key matching <code>restore-prefixes-first-match</code>.</li> <li><code>false</code> otherwise.</li> </ul> |
38-
| `restored-key` | <ul> <li>A string.</li> <li>The key of a cache restored via the <code>primary-key</code> or via the <code>restore-prefixes-first-match</code>.</li> <li>An empty string otherwise.</li> </ul> |
39-
| `restored-keys` | <ul> <li>A possibly empty array of strings (JSON).</li> <li>Keys of restored caches.</li> <li>Example: <code>["key1", "key2"]</code>.</li> </ul> |
32+
| name | description |
33+
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
34+
| `primary-key` | <ul> <li>A string.</li> <li>The <code>primary-key</code>.</li> </ul> |
35+
| `hit` | <ul> <li>A boolean string.</li> <li><code>'true'</code> when <code>hit-primary-key</code> is <code>true</code> or <code>hit-first-match</code> is <code>true</code>.</li> <li><code>'false'</code> otherwise.</li> </ul> |
36+
| `hit-primary-key` | <ul> <li>A boolean string.</li> <li><code>'true'</code> when there was a hit on the <code>primary-key</code>.</li> <li><code>'false'</code> otherwise.</li> </ul> |
37+
| `hit-first-match` | <ul> <li>A boolean string.</li> <li><code>'true'</code> when there was a hit on a key matching <code>restore-prefixes-first-match</code>.</li> <li><code>'false'</code> otherwise.</li> </ul> |
38+
| `restored-key` | <ul> <li>A string.</li> <li>The key of a cache restored via the <code>primary-key</code> or via the <code>restore-prefixes-first-match</code>.</li> <li>An empty string otherwise.</li> </ul> |
39+
| `restored-keys` | <ul> <li>A possibly empty array of strings (JSON).</li> <li>Keys of restored caches.</li> <li>Example: <code>["key1", "key2"]</code>.</li> </ul> |
4040

4141
<!-- action-docs-outputs action="action.yml" -->
4242

‎restore/action.yml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,19 @@ outputs:
9797
9898
hit:
9999
description: |
100-
- A boolean value.
101-
- `true` when `hit-primary-key` is `true` or `hit-first-match` is `true`.
102-
- `false` otherwise.
100+
- A boolean string.
101+
- `'true'` when `hit-primary-key` is `true` or `hit-first-match` is `true`.
102+
- `'false'` otherwise.
103103
hit-primary-key:
104104
description: |
105-
- A boolean value.
106-
- `true` when there was a hit on the `primary-key`.
107-
- `false` otherwise.
105+
- A boolean string.
106+
- `'true'` when there was a hit on the `primary-key`.
107+
- `'false'` otherwise.
108108
hit-first-match:
109109
description: |
110-
- A boolean value.
111-
- `true` when there was a hit on a key matching `restore-prefixes-first-match`.
112-
- `false` otherwise.
110+
- A boolean string.
111+
- `'true'` when there was a hit on a key matching `restore-prefixes-first-match`.
112+
- `'false'` otherwise.
113113
114114
restored-key:
115115
description: |

0 commit comments

Comments
 (0)