Skip to content

Commit ff5d6a7

Browse files
authored
chore(github action): Detect broken links in documentation (TanStack#473)
* chore(github action): Detect broken links in documentation * docs: update name
1 parent 827d5bc commit ff5d6a7

2 files changed

Lines changed: 43 additions & 2 deletions

File tree

‎.github/workflows/links-test.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Broken Link Checker
2+
3+
on:
4+
push:
5+
branches:
6+
- 'master'
7+
pull_request:
8+
9+
jobs:
10+
links-test:
11+
name: 'Check all readmes files'
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v2
15+
with:
16+
fetch-depth: 1
17+
- uses: urlstechie/urlchecker-action@0.2.1
18+
with:
19+
# A subfolder or path to navigate to in the present or cloned repository
20+
subfolder: /github/workspace/
21+
22+
# A comma-separated list of file types to cover in the URL checks
23+
file_types: .md,.mdx
24+
25+
# Choose whether to include file with no URLs in the prints.
26+
print_all: false
27+
28+
# The timeout seconds to provide to requests, defaults to 5 seconds
29+
timeout: 5
30+
31+
# How many times to retry a failed request (each is logged, defaults to 1)
32+
retry_count: 1
33+
34+
# A comma separated links to exclude during URL checks
35+
white_listed_urls:
36+
37+
# A comma separated patterns to exclude during URL checks
38+
white_listed_patterns:
39+
40+
# choose if the force pass or not
41+
force_pass: false

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ A big thanks to both [Draqula](https://github.com/vadimdemedes/draqula) for insp
102102
- [Microsoft](https://microsoft.com)
103103
- [Target](https://target.com)
104104
- [HP](https://hp.com)
105-
- [Major League Baseball Association](https://mlb.com)
106-
- [Volvo](https://volvocars.com)
105+
- [Major League Baseball Association](https://www.mlb.com)
106+
- [Volvo](https://www.volvocars.com)
107107
- [Ocado](https://ocado.com)
108108
- [UPC.ch](https://upc.ch)
109109
- [EFI.com](https://efi.com)

0 commit comments

Comments
 (0)