mirror of
https://github.com/ultralytics/ultralytics.git
synced 2025-09-15 15:48:41 +08:00
105 lines
3.8 KiB
YAML
105 lines
3.8 KiB
YAML
# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
|
|
|
|
# Continuous Integration (CI) GitHub Actions tests broken link checker using https://github.com/lycheeverse/lychee
|
|
# Ignores the following status codes to reduce false positives:
|
|
# - 401(Vimeo, 'unauthorized')
|
|
# - 403(OpenVINO, 'forbidden')
|
|
# - 429(Instagram, 'too many requests')
|
|
# - 500(Zenodo, 'cached')
|
|
# - 502(Zenodo, 'bad gateway')
|
|
# - 999(LinkedIn, 'unknown status code')
|
|
|
|
name: Check Broken links
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
schedule:
|
|
- cron: "0 0 * * *" # runs at 00:00 UTC every day
|
|
|
|
jobs:
|
|
Links:
|
|
if: github.repository == 'ultralytics/ultralytics'
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v5
|
|
|
|
- name: Install lychee
|
|
run: curl -sSfL "https://github.com/lycheeverse/lychee/releases/latest/download/lychee-x86_64-unknown-linux-gnu.tar.gz" | sudo tar xz -C /usr/local/bin
|
|
|
|
- name: Test Markdown and HTML links with retry
|
|
uses: ultralytics/actions/retry@main
|
|
with:
|
|
timeout_minutes: 60
|
|
retry_delay_seconds: 900
|
|
retries: 2
|
|
run: |
|
|
lychee \
|
|
--scheme https \
|
|
--timeout 60 \
|
|
--insecure \
|
|
--accept 100..=103,200..=299,401,403,429,500,502,999 \
|
|
--exclude-all-private \
|
|
--exclude 'https?://(www\.)?(linkedin\.com|twitter\.com|instagram\.com|kaggle\.com|fonts\.gstatic\.com|url\.com)' \
|
|
--exclude-path docs/zh \
|
|
--exclude-path docs/es \
|
|
--exclude-path docs/ru \
|
|
--exclude-path docs/pt \
|
|
--exclude-path docs/fr \
|
|
--exclude-path docs/de \
|
|
--exclude-path docs/ja \
|
|
--exclude-path docs/ko \
|
|
--exclude-path docs/hi \
|
|
--exclude-path docs/ar \
|
|
--github-token ${{ secrets.GITHUB_TOKEN }} \
|
|
--header "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.6478.183 Safari/537.36" \
|
|
'./**/*.md' \
|
|
'./**/*.html' | tee -a $GITHUB_STEP_SUMMARY
|
|
|
|
# Raise error if broken links found
|
|
if ! grep -q "0 Errors" $GITHUB_STEP_SUMMARY; then
|
|
exit 1
|
|
fi
|
|
|
|
- name: Test Markdown, HTML, YAML, Python and Notebook links with retry
|
|
if: github.event_name == 'workflow_dispatch'
|
|
uses: ultralytics/actions/retry@main
|
|
with:
|
|
timeout_minutes: 60
|
|
retry_delay_seconds: 900
|
|
retries: 2
|
|
run: |
|
|
lychee \
|
|
--scheme https \
|
|
--timeout 60 \
|
|
--insecure \
|
|
--accept 100..=103,200..=299,401,403,429,500,502,999 \
|
|
--exclude-all-private \
|
|
--exclude 'https?://(www\.)?(linkedin\.com|twitter\.com|instagram\.com|kaggle\.com|fonts\.gstatic\.com|url\.com)' \
|
|
--exclude-path './**/ci.yml' \
|
|
--exclude-path docs/zh \
|
|
--exclude-path docs/es \
|
|
--exclude-path docs/ru \
|
|
--exclude-path docs/pt \
|
|
--exclude-path docs/fr \
|
|
--exclude-path docs/de \
|
|
--exclude-path docs/ja \
|
|
--exclude-path docs/ko \
|
|
--exclude-path docs/hi \
|
|
--exclude-path docs/ar \
|
|
--github-token ${{ secrets.GITHUB_TOKEN }} \
|
|
--header "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.6478.183 Safari/537.36" \
|
|
'./**/*.md' \
|
|
'./**/*.html' \
|
|
'./**/*.yml' \
|
|
'./**/*.yaml' \
|
|
'./**/*.py' \
|
|
'./**/*.ipynb' | tee -a $GITHUB_STEP_SUMMARY
|
|
|
|
# Raise error if broken links found
|
|
if ! grep -q "0 Errors" $GITHUB_STEP_SUMMARY; then
|
|
exit 1
|
|
fi
|