Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pavelloz committed Nov 9, 2023
1 parent 10a5691 commit c9417fd
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ Store a result for a given commit SHA in a repo.

## Inputs

|name|description|
|-|-|
|`result`| The string result to be stored in the cache. If unspecified, the action will run in "restore only" mode.|
|`cache-group`|A string that will be added to the cache key. Defaults to the name of the current workflow.|
| name | description |
| ------------- | -------------------------------------------------------------------------------------------------------- |
| `result` | The string result to be stored in the cache. If unspecified, the action will run in "restore only" mode. |
| `cache-group` | A string that will be added to the cache key. Defaults to the name of the current workflow. |

## Outputs

|name|description|
|-|-|
|`result`| The string result of the action, either `'unknown'` or the given `result` value.|
| name | description |
| -------- | -------------------------------------------------------------------------------- |
| `result` | The string result of the action, either `'unknown'` or the given `result` value. |

## Examples

Expand All @@ -25,12 +25,12 @@ jobs:
runs-on: ubuntu-latest
steps:
- id: last-run
uses: parallel-markets/cache-result-action@master
uses: parallel-markets/cache-result-action@v1.0.0

- run: make test
if: steps.last-run.outputs.result != 'success'

- uses: parallel-markets/cache-result-action@master
- uses: parallel-markets/cache-result-action@v1.0.0
with:
result: success
```
Expand All @@ -45,15 +45,15 @@ jobs:
prev-result: ${{ steps.last-run.outputs.result }}
steps:
- id: last-run
uses: parallel-markets/cache-result-action@master
uses: parallel-markets/cache-result-action@v1.0.0
test:
runs-on: ubuntu-latest
needs: fetch-prev-result
if: needs.fetch-prev-result.outputs.prev_result != 'success'
steps:
- run: make test
- uses: parallel-markets/cache-result-action@master
- uses: parallel-markets/cache-result-action@v1.0.0
with:
result: success
```

0 comments on commit c9417fd

Please sign in to comment.