-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(github action): Detect broken links in documentation (#473)
* chore(github action): Detect broken links in documentation * docs: update name
- Loading branch information
Showing
2 changed files
with
43 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters