Skip to content

[CI] Add lychee link checker workflow - #12931

Draft
jbampton wants to merge 1 commit into
apache:mainfrom
jbampton:add-lychee-link-checker-workflow
Draft

[CI] Add lychee link checker workflow#12931
jbampton wants to merge 1 commit into
apache:mainfrom
jbampton:add-lychee-link-checker-workflow

Conversation

@jbampton

Copy link
Copy Markdown
Member

Description

This PR...

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • Build/CI
  • Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

@codecov

codecov Bot commented Mar 31, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 18.02%. Comparing base (7eea9ed) to head (20a9fdc).
⚠️ Report is 422 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #12931      +/-   ##
============================================
- Coverage     18.02%   18.02%   -0.01%     
- Complexity    16464    16465       +1     
============================================
  Files          5973     5973              
  Lines        537466   537466              
  Branches      65991    65991              
============================================
- Hits          96853    96852       -1     
- Misses       429690   429691       +1     
  Partials      10923    10923              
Flag Coverage Δ
uitests 3.52% <ø> (ø)
unittests 19.18% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

Copy link
Copy Markdown

This PR is stale because it has been open for 120 days with no activity. It may be removed by administrators of this project at any time. Remove the stale label or comment to request for removal of it to prevent this.

@DaanHoogland DaanHoogland left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clgtm. we may want to revisit the excludes soon.

uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
with:
args: --config lychee.toml .
fail: false

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fail: false here, and the report step only runs on schedule. So on a PR this always goes green and prints nothing. Is that intended, or should PRs surface the broken links somewhere?

persist-credentials: false
- name: Link Checker
id: lychee
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No GITHUB_TOKEN in the env, so github.com links get rate limited and come back looking broken. Worth adding?

permissions:
issues: write # required for Broken Links Report
steps:
- uses: actions/checkout@v6

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Every other workflow here pins actions by SHA. Pin this one and github-script below to match?

// Ensure the path is correct relative to the workspace root
const reportBody = fs.readFileSync('./lychee/out.md', 'utf8');

await github.rest.issues.create({

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This opens a new issue every Sunday. Should it update an existing open one instead?

Comment thread lychee.toml
"https://downloads.chef.io/chef-dk/",
"https://github.com/YOUR_ACCOUNT/cloudstack",
"https://iconka.com/en/downloads/cat-power/",
"https://issues.apache.org/.*",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This skips every Jira link in the repo. Can we narrow it once we see what actually breaks?

@Damans227 Damans227 moved this from Ready to In review in CloudStack Testing Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

3 participants