Skip to content

Commit

Permalink
fix(action): write that outputs are stringy booleans
Browse files Browse the repository at this point in the history
  • Loading branch information
@deemp
deemp committed Feb 18, 2025
1 parent d3c58ae commit 61d2f57
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 43 deletions.
16 changes: 8 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,14 +139,14 @@ See [action.yml](action.yml).

## Outputs

| name | description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `primary-key` | <ul> <li>A string.</li> <li>The <code>primary-key</code>.</li> </ul> |
| `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> |
| `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> |
| `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> |
| `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> |
| `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> |
| name | description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `primary-key` | <ul> <li>A string.</li> <li>The <code>primary-key</code>.</li> </ul> |
| `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> |
| `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> |
| `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> |
| `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> |
| `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> |

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

Expand Down
18 changes: 9 additions & 9 deletions action.nix
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,19 +233,19 @@ in
hit:
description: |
- A boolean value.
- `true` when ${q hit-primary-key} is `true` or ${q hit-first-match} is `true`.
- `false` otherwise.
- A boolean string.
- `'true'` when ${q hit-primary-key} is `true` or ${q hit-first-match} is `true`.
- `'false'` otherwise.
${hit-primary-key}:
description: |
- A boolean value.
- `true` when there was a hit on the ${q primary-key}.
- `false` otherwise.
- A boolean string.
- `'true'` when there was a hit on the ${q primary-key}.
- `'false'` otherwise.
${hit-first-match}:
description: |
- A boolean value.
- `true` when there was a hit on a key matching ${q restore-prefixes-first-match}.
- `false` otherwise.
- A boolean string.
- `'true'` when there was a hit on a key matching ${q restore-prefixes-first-match}.
- `'false'` otherwise.
restored-key:
description: |
Expand Down
18 changes: 9 additions & 9 deletions action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,19 +154,19 @@ outputs:
hit:
description: |
- A boolean value.
- `true` when `hit-primary-key` is `true` or `hit-first-match` is `true`.
- `false` otherwise.
- A boolean string.
- `'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.
- A boolean string.
- `'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.
- A boolean string.
- `'true'` when there was a hit on a key matching `restore-prefixes-first-match`.
- `'false'` otherwise.
restored-key:
description: |
Expand Down
16 changes: 8 additions & 8 deletions restore/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ The restore action restores a cache. It works similarly to the `cache` action ex

## Outputs

| name | description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `primary-key` | <ul> <li>A string.</li> <li>The <code>primary-key</code>.</li> </ul> |
| `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> |
| `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> |
| `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> |
| `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> |
| `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> |
| name | description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `primary-key` | <ul> <li>A string.</li> <li>The <code>primary-key</code>.</li> </ul> |
| `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> |
| `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> |
| `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> |
| `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> |
| `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> |

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

Expand Down
18 changes: 9 additions & 9 deletions restore/action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,19 +97,19 @@ outputs:
hit:
description: |
- A boolean value.
- `true` when `hit-primary-key` is `true` or `hit-first-match` is `true`.
- `false` otherwise.
- A boolean string.
- `'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.
- A boolean string.
- `'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.
- A boolean string.
- `'true'` when there was a hit on a key matching `restore-prefixes-first-match`.
- `'false'` otherwise.
restored-key:
description: |
Expand Down

0 comments on commit 61d2f57

Please sign in to comment.