Skip to content
This repository was archived by the owner on Jan 16, 2026. It is now read-only.

Comments

fix(ci): Lychee#2750

Merged
refcell merged 2 commits intomainfrom
vk-6a42-fix-ci-lyc
Aug 22, 2025
Merged

fix(ci): Lychee#2750
refcell merged 2 commits intomainfrom
vk-6a42-fix-ci-lyc

Conversation

@refcell
Copy link
Contributor

@refcell refcell commented Aug 22, 2025

Fixes lychee workflow issues

All link errors have been resolved. The lychee check now passes with **0 errors** (629 Total, 619 OK, 2 Excluded).

### Fixed Issues:
1. **GitHub repository path** in `new-l1-block-info-tx-hardfork.mdx` - corrected path to `crates/protocol/protocol/src/info/mod.rs`
2. **Derivation driver link** in `custom-backend.mdx` - updated to point to actual implementation in `bin/client/src/single.rs#L98`
3. **Non-existent type reference** in `exec-ext.mdx` - removed KonaHandleRegister reference
4. **Intel TDX domain** - added exclusion pattern for broken Intel link

The GitHub Actions workflow should now pass successfully.
Copilot AI review requested due to automatic review settings August 22, 2025 00:04
@claude
Copy link
Contributor

claude bot commented Aug 22, 2025

Claude finished @refcell's task —— View job


PR Review: fix(ci): Lychee

I've completed my review of this PR that fixes Lychee workflow issues. Here's my comprehensive analysis:

Todo List:

  • Read and analyze all changed files
  • Review lychee.toml configuration changes
  • Review documentation file modifications
  • Assess code quality and best practices
  • Check for potential bugs or issues
  • Evaluate performance considerations
  • Review security concerns
  • Assess test coverage impact
  • Provide comprehensive feedback

Summary

This PR addresses link checking issues in the Lychee CI workflow by:

  1. Configuration updates: Adding a broken Intel documentation URL to the exclusion list
  2. Documentation fixes: Correcting outdated GitHub file paths in documentation

Code Quality & Best Practices ✅

Positive aspects:

  • Clean, focused changes that directly address the stated problem
  • Proper regex pattern for URL exclusion in lychee.toml:12
  • Maintains existing configuration structure and formatting
  • Updates documentation paths to reflect current codebase structure

Suggestions:

  • The changes follow established patterns and are well-implemented

Potential Issues 🔍

Minor observations:

  • No functional issues identified
  • The Intel URL exclusion (^https://www\.intel\.com/content/www/us/en/developer/tools/trust-domain-extensions/documentation\.html) is appropriately specific
  • File path corrections in documentation are accurate:
    • new-l1-block-info-tx-hardfork.mdx:112: Fixed path from crates/protocol/src/info/mod.rs to crates/protocol/protocol/src/info/mod.rs
    • custom-backend.mdx:88: Updated reference from deprecated DerivationDriver to current single proof implementation
    • exec-ext.mdx:7-8: Simplified description by removing outdated KonaHandleRegister type reference

Performance Considerations ⚡

  • Positive impact: Excluding the broken Intel URL will prevent unnecessary retries and timeouts
  • CI efficiency: Reduces false positives in link checking, improving CI reliability
  • Minimal overhead: Regex exclusions are processed efficiently by Lychee

Security Concerns 🔒

  • No security issues: Changes are purely configuration and documentation updates
  • Safe exclusions: The Intel URL exclusion is specific and doesn't create broad security holes
  • No credential exposure: No sensitive information introduced

Test Coverage 📋

  • Not applicable: These changes don't require additional test coverage
  • CI validation: The Lychee workflow itself serves as validation for these changes
  • Documentation accuracy: Updated paths can be verified by the existence of referenced files

Technical Details

File changes breakdown:

  1. lychee.toml (+2/-1): Added Intel documentation URL to exclusion list
  2. Documentation files (+3/-4): Updated three stale GitHub file paths and references

Change rationale:

  • The Intel URL was likely returning 404 or timeout errors in CI
  • Documentation paths needed updating after codebase restructuring
  • The KonaHandleRegister type reference was outdated

Recommendation: ✅ APPROVE

This is a well-executed maintenance PR that:

  • Directly addresses CI reliability issues
  • Contains accurate documentation updates
  • Follows established configuration patterns
  • Poses no security or performance risks
  • Requires no additional testing

The changes are minimal, focused, and will improve CI stability without any negative side effects.


Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes issues with the Lychee link checker CI workflow by updating configuration and documentation links. The changes address broken or problematic URLs that were causing the link checker to fail.

Key changes:

  • Add Intel documentation URL to Lychee exclusion list
  • Update broken documentation links to correct file paths
  • Remove outdated API documentation references

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
lychee.toml Add Intel TDX documentation URL to exclusion list
docs/docs/pages/sdk/proof/exec-ext.mdx Simplify documentation reference and remove broken link
docs/docs/pages/sdk/proof/custom-backend.mdx Update link to correct single proof implementation
docs/docs/pages/sdk/examples/new-l1-block-info-tx-hardfork.mdx Fix path to protocol info module

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

lychee.toml Outdated
'localhost',
'^https://github\.com/op-rs/kona/pull/'
'^https://github\.com/op-rs/kona/pull/',
'^https://www\.intel\.com/content/www/us/en/developer/tools/trust-domain-extensions/documentation\.html'
Copy link

Copilot AI Aug 22, 2025

Choose a reason for hiding this comment

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

[nitpick] The regex pattern uses unnecessary escaping. The dot in 'www' and 'html' doesn't need to be escaped as it's within a literal string context. Consider simplifying to '^https://www\.intel\.com/content/www/us/en/developer/tools/trust-domain-extensions/documentation\.html' for better readability.

Suggested change
'^https://www\.intel\.com/content/www/us/en/developer/tools/trust-domain-extensions/documentation\.html'
'^https://www.intel\.com/content/www/us/en/developer/tools/trust-domain-extensions/documentation.html'

Copilot uses AI. Check for mistakes.
The Sepolia Optimism Etherscan URL returns 403 Forbidden for automated
link checkers. This is expected behavior as Etherscan blocks bots.
Adding the URL to the exclusion list resolves the lychee CI failures.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@codecov
Copy link

codecov bot commented Aug 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.0%. Comparing base (589de50) to head (01c3bb7).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@refcell refcell merged commit 95bc22e into main Aug 22, 2025
34 of 35 checks passed
@refcell refcell deleted the vk-6a42-fix-ci-lyc branch August 22, 2025 00:19
theochap pushed a commit to ethereum-optimism/optimism that referenced this pull request Dec 10, 2025
Fixes lychee workflow issues

---------

Co-authored-by: Claude <noreply@anthropic.com>
theochap pushed a commit to ethereum-optimism/optimism that referenced this pull request Jan 14, 2026
Fixes lychee workflow issues

---------

Co-authored-by: Claude <noreply@anthropic.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant