augur
augur copied to clipboard
Update checks workflow to fix the broken link issue-3152
Pull Request Description
Title: Update checks workflow and add CI badges to README
Summary
This PR updates the CI/CD workflow (.github/workflows/checks.yml) and adds live status badges to README.md. It ensures broken links are automatically detected and provides real-time feedback on workflow health.
Key Updates
-
Workflow Improvements
- Added a broken links checker using [Lychee](https://lycheeverse.org/) with artifact upload (
./lychee/out.md). - Runs after docs build (
needs: check-docs) and integrates with existing jobs:check-docs,run-pylint,misspell,uv-lock.
- Added a broken links checker using [Lychee](https://lycheeverse.org/) with artifact upload (
-
README Enhancements
- Added status badges for each CI job: Docs Build, Pylint, Spellcheck, UV Lock, Broken Links.
- Badges link directly to workflow logs.
Benefits
- Prevents broken links from being merged.
- Provides real-time CI feedback via badges.
- Improves visibility and maintainability of CI/CD workflows.
Related Issues
- Fixes: #3152
Reviewer Notes
- Verify the broken links job runs correctly.
- Check that badges render and workflow jobs function as expected.
Signed Commits
- [x] All commits are signed.
ok ... i see the lint checker for broken links is working ... and that's the issue ...
Superseded by #3484