augur icon indicating copy to clipboard operation
augur copied to clipboard

Update checks workflow to fix the broken link issue-3152

Open Kushagra651 opened this issue 3 months ago • 1 comments

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

  1. 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.
  2. 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.

Kushagra651 avatar Sep 12 '25 10:09 Kushagra651

ok ... i see the lint checker for broken links is working ... and that's the issue ...

sgoggins avatar Oct 16 '25 19:10 sgoggins

Superseded by #3484

MoralCode avatar Dec 19 '25 18:12 MoralCode