Successfully combined and simplified the link checking workflows and documentation into a unified system.
.github/workflows/link-health-guardian.yml
- Duplicate complex workflow (370 lines).github/workflows/README_link_checker.md
- Outdated workflow documentation (282 lines)scripts/README-link-checker.md
- Standalone link checker documentation.github/workflows/link-checker.yml
- Single unified workflow (202 lines)scripts/README.md
- Comprehensive documentation with merged contentscripts/link-checker.py
- Unified Python script (all functionality)link-checker.yml
+ link-health-guardian.yml
.github/workflows/
└── link-checker.yml # Unified workflow (202 lines)
scripts/
├── link-checker.py # Comprehensive Python script
└── README.md # Complete documentation
Parameter | Description | Default | Options |
---|---|---|---|
scope |
Content to check | website |
website , internal , external , docs , posts , quests , all |
analysis_level |
Analysis depth | comprehensive |
basic , standard , comprehensive , ai-only |
create_issue |
Create GitHub issue | true |
true , false |
ai_analysis |
Enable AI analysis | true |
true , false |
timeout |
Request timeout | 30 |
10 , 20 , 30 , 45 , 60 seconds |
# Basic website check
python3 scripts/link-checker.py --scope website
# Comprehensive analysis with AI and GitHub issue
python3 scripts/link-checker.py --scope website --analysis-level comprehensive --create-issue --repository bamr87/it-journey
# Quick internal links check without AI
python3 scripts/link-checker.py --scope internal --analysis-level basic --no-ai
When enabled (requires OPENAI_API_KEY
):
link-checker.py
scripts/README.md
GITHUB_TOKEN
(for issue creation)OPENAI_API_KEY
(for AI analysis)contents: read
, issues: write
The Link Health Guardian now provides maximum functionality with minimal complexity through unified architecture and comprehensive documentation.