|
1 |
| -# Using https://github.com/wummel/linkchecker to test NGINX Documentation |
| 1 | +# Using https://github.com/linkchecker/linkchecker to test NGINX Documentation |
2 | 2 | # Recursively checks all internal and external links in the docs.
|
3 | 3 | # Warnings for redirects are disabled
|
4 | 4 | # To ignore a url use the add to the env.ignore list. eg --ignore-url ^http://www.example.com
|
|
10 | 10 | workflow_dispatch:
|
11 | 11 | inputs:
|
12 | 12 | basepath:
|
13 |
| - description: 'Base path for the documentation (default: https://docs.nginx.com)' |
14 |
| - required: false |
15 |
| - default: 'https://docs.nginx.com' |
| 13 | + description: "Documentation site to test (default: https://docs.nginx.com)" |
| 14 | + required: true |
| 15 | + default: "https://docs.nginx.com" |
| 16 | + type: choice |
| 17 | + options: |
| 18 | + - "https://docs.nginx.com" |
| 19 | + - "https://docs-dev.nginx.com" |
| 20 | + - "https://docs-staging.nginx.com" |
16 | 21 | schedule:
|
17 | 22 | # Runs every day at 7am UTC
|
18 | 23 | - cron: '0 7 * * *'
|
|
21 | 26 | defaults: '--no-warnings --check-extern --ignore-url ^https://consent.trustarc.com'
|
22 | 27 | ignore: >
|
23 | 28 | --ignore-url ^http://127.0.0.1 --ignore-url ^http://localhost --ignore-url ^http://serv/ --ignore-url ^https://myserver.host.com
|
24 |
| - --ignore-url ^https://product.apis.f5.com --ignore-url ^https://product-s.apis.f5.com |
25 |
| - --ignore-url ^http://www.example.com --ignore-url ^file:// --ignore-url ^https://www.fastbot.de |
26 |
| - --ignore-url ^https://lightstep.com --ignore-url ^https://www.owasp.org/ --ignore-url ^https://www.maxmind.com |
| 29 | + --ignore-url ^https://product.apis.f5.com --ignore-url ^https://product-s.apis.f5.com --ignore-url ^https://linux.die.net/man/ |
| 30 | + --ignore-url ^http://www.example.com --ignore-url ^file:// --ignore-url ^https://www.fastbot.de --ignore-url ^https://www.domain.com |
| 31 | + --ignore-url ^https://lightstep.com --ignore-url ^https://www.owasp.org/ --ignore-url ^https://www.maxmind.com --ignore-url ^https://www.splunk.com/ |
27 | 32 | --ignore-url ^https://oauth2.googleapis.com --ignore-url ^https://openidconnect.googleapis.com --ignore-url ^https://www.base64url.com/
|
28 |
| - --ignore-url ^https://docs.nginx.com/nginx-ingress-controller/css |
29 |
| - --ignore-url ^https://docs.nginx.com/nginxaas/azure/css |
30 |
| - --ignore-url ^https://docs.nginx.com/nginx-gateway-fabric/css |
| 33 | + --ignore-url ^https://go.googlesource.com/ --ignore-url ^https://go.googlesource.com/sync --ignore-url ^https://linkerd.io/2.13/ |
| 34 | + --ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginx-ingress-controller/css |
| 35 | + --ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginxaas/azure/css |
| 36 | + --ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginx-gateway-fabric/css |
31 | 37 |
|
32 | 38 | jobs:
|
33 | 39 | link-checker:
|
|
96 | 102 |
|
97 | 103 | # Run LinkChecker
|
98 | 104 | - name: Run LinkChecker on ${{ matrix.doc_paths }}
|
| 105 | + continue-on-error: ${{ env.isProduction != 'true' }} |
99 | 106 | uses: nick-fields/retry@7152eba30c6575329ac0576536151aca5a72780e # v3.0.0
|
100 | 107 | with:
|
101 | 108 | timeout_minutes: 10
|
|
0 commit comments