Skip to content

Fix lychee install workflows#301

Merged
glenn-jocher merged 1 commit into
mainfrom
codex/fix-lychee-install-20260425
Apr 25, 2026
Merged

Fix lychee install workflows#301
glenn-jocher merged 1 commit into
mainfrom
codex/fix-lychee-install-20260425

Conversation

@glenn-jocher
Copy link
Copy Markdown
Member

@glenn-jocher glenn-jocher commented Apr 25, 2026

Summary\n- Extract the lychee binary from the nested release archive path in both link workflows\n- Match the working handbook install command pattern\n\n## Tests\n- actionlint -ignore SC2004 -ignore SC2086 -ignore SC2129 .github/workflows/links.yml .github/workflows/links_local.yml\n- git diff --check -- .github/workflows/links.yml .github/workflows/links_local.yml\n- Verified latest lychee archive contains lychee-x86_64-unknown-linux-gnu/lychee\n\nNote: plain actionlint still reports pre-existing ShellCheck warnings in .github/workflows/links.yml unrelated to this change.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

🔧 This PR improves the docs link-checking workflows by fixing how the lychee link checker is installed in GitHub Actions, making CI runs more reliable.

📊 Key Changes

  • Updated the lychee installation step in both .github/workflows/links.yml and .github/workflows/links_local.yml.
  • Changed the extraction command to unpack only the lychee binary from the downloaded archive instead of extracting the full archive directly into /usr/local/bin.
  • Added --strip-components=1 so the binary is placed in the correct location without nested folders.
  • Kept the rest of the link-checking workflow unchanged, including dependency installation and local/remote link validation steps.

🎯 Purpose & Impact

  • ✅ Fixes a workflow setup issue that could prevent the link checker from being installed correctly.
  • 🚀 Makes automated link validation more dependable for the ultralytics/docs repository.
  • 🛠️ Reduces CI failures caused by archive structure differences, helping contributors and maintainers catch real broken links instead of setup errors.
  • 📚 Improves the overall stability of documentation quality checks, which supports a smoother docs publishing process.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 25, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Apr 25, 2026 1:10pm

Request Review

@UltralyticsAssistant UltralyticsAssistant added bug Something isn't working devops GitHub Devops or MLops fixed Bug has been resolved labels Apr 25, 2026
@UltralyticsAssistant
Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/docs 🚀 PR! This is an automated message to help streamline review, and an engineer will assist you soon. Please review the checklist below for a smooth integration ✨

  • Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • Synchronize with Source: Confirm your PR is synchronized with the ultralytics/docs main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • Update Documentation: Update the relevant documentation for any new or modified features.
  • Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don't hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀

Copy link
Copy Markdown
Member

@UltralyticsAssistant UltralyticsAssistant left a comment

Choose a reason for hiding this comment

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

🔍 PR Review

Made with ❤️ by Ultralytics Actions

The PR looks clean. The updated workflow commands consistently extract only the lychee binary into /usr/local/bin, and I don't see any clear correctness, reliability, or maintainability issues in the changed lines.

@glenn-jocher glenn-jocher merged commit 3e25450 into main Apr 25, 2026
7 checks passed
@glenn-jocher glenn-jocher deleted the codex/fix-lychee-install-20260425 branch April 25, 2026 13:11
@UltralyticsAssistant
Copy link
Copy Markdown
Member

🎉 Merged—thank you, @glenn-jocher!

“Quality is not an act, it is a habit.” — Aristotle

This update is a great example of that mindset: a small but important workflow fix that makes link-checking more reliable, reduces avoidable CI noise, and helps the ultralytics/docs repo stay focused on catching real issues. Really appreciate the careful improvement to the lychee install step and the continued attention to docs quality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working devops GitHub Devops or MLops fixed Bug has been resolved

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants