Skip to content
This repository has been archived by the owner on Oct 18, 2022. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
peter-evans committed Jan 22, 2020
1 parent dc36c12 commit a5a8d5b
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,31 @@ jobs:
labels: report, automated issue
```

## Issue sample
#### Issue sample

[This link](https://aoushaoueshosuhoshuoeu.com) is intentionally non-existent.
The workflow in this repository generated [this sample issue](https://github.com/peter-evans/link-checker/issues/1).

#### Creating a failing check for link errors

To create a failing check when there are link errors you can use the `exit_code` output from the action as follows.

```yml
on: push
jobs:
linkChecker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Link Checker
id: lc
uses: peter-evans/link-checker@v1
with:
args: -v -r *
- name: Fail if there were link errors
run: exit ${{ steps.lc.outputs.exit_code }}
```

## License

MIT License - see the [LICENSE](LICENSE) file for details

0 comments on commit a5a8d5b

Please # to comment.