Skip to content

Commit

Permalink
docs: add github actions example (#228)
Browse files Browse the repository at this point in the history
  • Loading branch information
JustinBeckwith authored Dec 30, 2020
1 parent d7c4758 commit 96a8750
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,28 @@ To load config settings outside the CWD, you can pass the `--config` flag to the
$ linkinator --config /some/path/your-config.json
```

## GitHub Actions
You can use `linkinator` as a GitHub Action as well, using [JustinBeckwith/linkinator-action](https://github.com/JustinBeckwith/linkinator-action):

```yaml
on:
push:
branches:
- main
pull_request:
name: ci
jobs:
linkinator:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: JustinBeckwith/linkinator-action@v1
with:
paths: README.md
```
To see all options or to learn more, visit [JustinBeckwith/linkinator-action](https://github.com/JustinBeckwith/linkinator-action).
## API Usage
#### linkinator.check(options)
Expand Down

0 comments on commit 96a8750

Please sign in to comment.