Skip to content

Commit

Permalink
refactor(docs): add details
Browse files Browse the repository at this point in the history
  • Loading branch information
@deemp
deemp committed Apr 3, 2024
1 parent 954affa commit 792403b
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,9 @@ See [action.yml](action.yml).
| `purge` | <ul> <li>When <code>true</code>, the action purges (possibly zero) caches.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `false` |
| `purge-primary-key` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>When <code>always</code>, the action always purges cache with the <code>primary-key</code>.</li> <li>When <code>never</code>, the action never purges cache with the <code>primary-key</code>.</li> <li>Otherwise, this input has no effect..</li> </ul> | `false` | `""` |
| `purge-prefixes` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>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 <a href="https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables">GITHUB_REF</a>.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `""` |
| `purge-last-accessed` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>When a number, the action purges selected caches that were last accessed more than this number of seconds ago relative to the start of the <code>Post Restore</code> phase.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `""` |
| `purge-created` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>When a number, the action purges caches created more than this number of seconds ago relative to the start of the <code>Post Restore</code> phase.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `""` |
| `upload-chunk-size` | <ul> <li>When a number, the action uses it as the chunk size (in bytes) to split up large files during upload.</li> <li>Otherwise, the action uses the default value <code>33554432</code> (32MB).</li> </ul> | `false` | `""` |
| `purge-last-accessed` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>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 <code>Post Restore</code> phase.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `""` |
| `purge-created` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>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 <code>Post Restore</code> phase.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `""` |
| `upload-chunk-size` | <ul> <li>When a non-negative number, the action uses it as the chunk size (in bytes) to split up large files during upload.</li> <li>Otherwise, the action uses the default value <code>33554432</code> (32MB).</li> </ul> | `false` | `""` |
| `save-always` | <p>Run the post step to save the cache even if another step before fails.</p> | `false` | `false` |
| `token` | <p>The action uses it to communicate with GitHub API.</p> | `false` | `${{ github.token }}` |

Expand Down
6 changes: 3 additions & 3 deletions action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,21 +113,21 @@ inputs:
purge-last-accessed:
description: |
- Can have an effect only when `purge: true`.
- When a 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.
- 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 number, the action purges caches created more than this number of seconds ago relative to the start of the `Post Restore` phase.
- 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 number, the action uses it as the chunk size (in bytes) to split up large files during upload.
- 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: ""

Expand Down
6 changes: 3 additions & 3 deletions save/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ The save action saves a cache. It works similarly to the `cache` action except t
| `purge` | <ul> <li>When <code>true</code>, the action purges (possibly zero) caches.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `false` |
| `purge-primary-key` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>When <code>always</code>, the action always purges cache with the <code>primary-key</code>.</li> <li>When <code>never</code>, the action never purges cache with the <code>primary-key</code>.</li> <li>Otherwise, this input has no effect..</li> </ul> | `false` | `""` |
| `purge-prefixes` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>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 <a href="https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables">GITHUB_REF</a>.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `""` |
| `purge-last-accessed` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>When a number, the action purges selected caches that were last accessed more than this number of seconds ago relative to the start of the <code>Post Restore</code> phase.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `""` |
| `purge-created` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>When a number, the action purges caches created more than this number of seconds ago relative to the start of the <code>Post Restore</code> phase.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `""` |
| `upload-chunk-size` | <ul> <li>When a number, the action uses it as the chunk size (in bytes) to split up large files during upload.</li> <li>Otherwise, the action uses the default value <code>33554432</code> (32MB).</li> </ul> | `false` | `""` |
| `purge-last-accessed` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>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 <code>Post Restore</code> phase.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `""` |
| `purge-created` | <ul> <li>Can have an effect only when <code>purge: true</code>.</li> <li>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 <code>Post Restore</code> phase.</li> <li>Otherwise, this input has no effect.</li> </ul> | `false` | `""` |
| `upload-chunk-size` | <ul> <li>When a non-negative number, the action uses it as the chunk size (in bytes) to split up large files during upload.</li> <li>Otherwise, the action uses the default value <code>33554432</code> (32MB).</li> </ul> | `false` | `""` |
| `save-always` | <p>Run the post step to save the cache even if another step before fails.</p> | `false` | `false` |
| `token` | <p>The action uses it to communicate with GitHub API.</p> | `false` | `${{ github.token }}` |

Expand Down
Loading

0 comments on commit 792403b

Please sign in to comment.