Skip to content

Commit

Permalink
chore(github action): Detect broken links in documentation (#473)
Browse files Browse the repository at this point in the history
* chore(github action): Detect broken links in documentation

* docs: update name
  • Loading branch information
gargroh authored May 9, 2020
1 parent 827d5bc commit ff5d6a7
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 2 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/links-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Broken Link Checker

on:
push:
branches:
- 'master'
pull_request:

jobs:
links-test:
name: 'Check all readmes files'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 1
- uses: urlstechie/[email protected]
with:
# A subfolder or path to navigate to in the present or cloned repository
subfolder: /github/workspace/

# A comma-separated list of file types to cover in the URL checks
file_types: .md,.mdx

# Choose whether to include file with no URLs in the prints.
print_all: false

# The timeout seconds to provide to requests, defaults to 5 seconds
timeout: 5

# How many times to retry a failed request (each is logged, defaults to 1)
retry_count: 1

# A comma separated links to exclude during URL checks
white_listed_urls:

# A comma separated patterns to exclude during URL checks
white_listed_patterns:

# choose if the force pass or not
force_pass: false
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ A big thanks to both [Draqula](https://github.com/vadimdemedes/draqula) for insp
- [Microsoft](https://microsoft.com)
- [Target](https://target.com)
- [HP](https://hp.com)
- [Major League Baseball Association](https://mlb.com)
- [Volvo](https://volvocars.com)
- [Major League Baseball Association](https://www.mlb.com)
- [Volvo](https://www.volvocars.com)
- [Ocado](https://ocado.com)
- [UPC.ch](https://upc.ch)
- [EFI.com](https://efi.com)
Expand Down

0 comments on commit ff5d6a7

Please sign in to comment.