Skip to content

Commit 04cc386

Browse files
committed
Add awesomebot github action
Awesomebot will check all the links in README.md and ensure they're still alive. Includes example (img.shields.io has been a problem on my own repos) showing how to whitelist sites with intermittent issues so they don't block PR checks. - Whitelisted http://127.0.0.1:8080 because the link checker finds it in the examples section. - Whitelisted https://github.com/lima-vm/lima/releases/download so the link checker doesn't complain about the variable interpolation Use `--request-delay 1` so that it doesn't hit rate limits for sites that have multiple links pointing at them. Signed-off-by: Joe Block <[email protected]> whitelist test for download link
1 parent 15aba00 commit 04cc386

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

.github/workflows/awesomebot.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Check links in README.md
2+
3+
on:
4+
push:
5+
branches: [ '*' ]
6+
pull_request:
7+
branches: [ '*' ]
8+
9+
jobs:
10+
build:
11+
12+
runs-on: ubuntu-20.04
13+
14+
steps:
15+
- uses: actions/checkout@v2
16+
- uses: docker://dkhamsing/awesome_bot:latest
17+
with:
18+
args: /github/workspace/README.md --allow-dupe --allow-redirect --request-delay 1 --white-list https://img.shields.io,http://127.0.0.1:8080,https://github.com/lima-vm/lima/releases/download

0 commit comments

Comments
 (0)