Skip to content

Commit

Permalink
test stylings
Browse files Browse the repository at this point in the history
  • Loading branch information
Cammisuli committed May 14, 2024
1 parent 205f122 commit fbf427f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions workflow-steps/cache/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Usage
# Usage

```yaml
- name: Git Cache Step
Expand All @@ -9,9 +9,9 @@
base_branch: 'main'
```

### Inputs
## Inputs

#### `key` <img src="https://img.shields.io/badge/default_value-%27package--lock%2Ejson%7Cyarn%2Elock%7Cpnpm--lock%2Eyaml%27-D3D3D3" style="vertical-align: middle;">
## `key` ![default](https://img.shields.io/badge/default_value-%27package--lock%2Ejson%7Cyarn%2Elock%7Cpnpm--lock%2Eyaml%27-D3D3D3)

The keys can contain a combination of strings or globs that need to be hashed.

Expand All @@ -31,7 +31,7 @@ You can also point it directly to a specific file to be hashed:
key: '"some-string" | yarn.lock'
```

#### `paths` <img src="https://img.shields.io/badge/required-E53935" style="vertical-align: middle;">
## `paths` ![required](https://img.shields.io/badge/required-E53935)

You will normally upload a single folder under a key:

Expand All @@ -51,7 +51,7 @@ paths: |

All above locations will be cached and subsequently restored.

#### `base-branch`
## `base-branch`

For security reasons, this step will only write cache entries **for the current branch only**. This isolation is
essential, for example, for open source projects, where anyone can create PRs and potentially push malicious artefacts
Expand Down

0 comments on commit fbf427f

Please sign in to comment.