Skip to content

Commit c7d508a

Browse files
committed
update
1 parent f2aba91 commit c7d508a

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
11
# setup-shfmt
22

3-
- Install shfmt and cache it for GitHub Actions
3+
- Install [shfmt](https://github.com/mvdan/sh) and cache it for GitHub Actions
4+
- Caching makes it especially efficient when using self-hosted runners
5+
6+
## Usage
7+
8+
```yaml
9+
jobs:
10+
shfmt:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: pollenjp/setup-shfmt@v1
14+
with:
15+
version: latest
16+
- uses: actions/checkout@v4
17+
- name: Run shfmt
18+
run: shfmt -d .
19+
```

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'setup-shfmt'
1+
name: 'setup-shfmt-action'
22
description: 'Install shfmt and cache it for GitHub Actions'
33
author: 'pollenJP'
44

0 commit comments

Comments
 (0)