Skip to content

Commit 96a8750

Browse files
authoredDec 30, 2020
docs: add github actions example (#228)
1 parent d7c4758 commit 96a8750

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed
 

‎README.md

+22
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,28 @@ To load config settings outside the CWD, you can pass the `--config` flag to the
153153
$ linkinator --config /some/path/your-config.json
154154
```
155155

156+
## GitHub Actions
157+
You can use `linkinator` as a GitHub Action as well, using [JustinBeckwith/linkinator-action](https://github.com/JustinBeckwith/linkinator-action):
158+
159+
```yaml
160+
on:
161+
push:
162+
branches:
163+
- main
164+
pull_request:
165+
name: ci
166+
jobs:
167+
linkinator:
168+
runs-on: ubuntu-latest
169+
steps:
170+
- uses: actions/checkout@v2
171+
- uses: JustinBeckwith/linkinator-action@v1
172+
with:
173+
paths: README.md
174+
```
175+
176+
To see all options or to learn more, visit [JustinBeckwith/linkinator-action](https://github.com/JustinBeckwith/linkinator-action).
177+
156178
## API Usage
157179
158180
#### linkinator.check(options)

0 commit comments

Comments
 (0)
Please sign in to comment.