Document inputs and outputs

This commit is contained in:
Sascha Mann
2021-12-26 15:27:55 +01:00
committed by GitHub
parent 62b1570293
commit 1147e31aae

View File

@@ -16,6 +16,29 @@ Using this action is equivalent to including the following step in your workflow
${{ runner.os }}-
```
## Usage
### Inputs
```yaml
- uses: julia-actions/cache-artifacts@v1
with:
# The cache name is used as part of the cache key.
# It is equivalent to the cache-name environment variable in the snippet above.
#
# Default: cache-artifacts
cache-name: ''
```
### Outputs
```yaml
outputs:
# A boolean value to indicate an exact match was found for the primary key.
# Forwarded from actions/cache, check its documentation for more info.
cache-hit: ''
```
## Third Party Notice
This action is built around [`actions/cache`](https://github.com/actions/cache/) and includes parts of that action. `actions/cache` has been released under the following licence: