θΏ™ζ˜―indexlocζδΎ›ηš„ζœεŠ‘οΌŒδΈθ¦θΎ“ε…₯任何密码
Skip to content

Update links.yml #13563

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 17, 2025
Merged

Update links.yml #13563

merged 1 commit into from
Apr 17, 2025

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Apr 17, 2025

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Improves link checking in the CI workflow by ensuring broken links cause the workflow to fail. 🚦

πŸ“Š Key Changes

  • Removes unnecessary shell option (set -o pipefail) from link-checking steps.
  • Adds a check that explicitly fails the workflow if any broken links are detected in Markdown, HTML, YAML, Python, or Notebook files.

🎯 Purpose & Impact

  • Ensures all documentation and code files remain free of broken links, improving quality and reliability. πŸ”—
  • Makes it easier for contributors to spot and fix link issues before merging, leading to a better user experience. πŸ‘
  • Helps maintain high standards for project documentation and code references.

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Apr 17, 2025
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting an ultralytics/yolov5 πŸš€ pull request! This is an automated response to help streamline our review processβ€”an Ultralytics engineer will also assist you soon.

To ensure a smooth integration, please review the following checklist:

  • βœ… 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 and follow project conventions.
  • βœ… Synchronize with Source: Confirm your PR is up to date with the ultralytics/yolov5 main branch. If needed, update by clicking 'Update branch' or running git pull and git merge main locally.
  • βœ… Ensure CI Checks Pass: Make sure all Ultralytics Continuous Integration (CI) checks are passing. Address any failed checks.
  • βœ… Update Documentation: If you’ve modified or added features, please update the relevant documentation.
  • βœ… Add Tests: Where applicable, include or update tests for your changes, and confirm all tests pass.
  • βœ… Sign the CLA: If this is your first contribution, sign our Contributor License Agreement by commenting "I have read the CLA Document and I sign the CLA" below.
  • βœ… Minimize Changes: Please keep changes to the minimum required for your update. "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, check out our Contributing Guide. If you have any questions or need clarification, feel free to comment here. Thank you for contributing and helping keep our project robust and user-friendly! πŸŒŸπŸ”—

@glenn-jocher glenn-jocher merged commit 78daef4 into master Apr 17, 2025
9 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch April 17, 2025 17:56
@UltralyticsAssistant
Copy link
Member

Fantastic work, @glenn-jocher! πŸš€ This merge represents another step forward in keeping our documentation world-class and dependable. As Helen Keller said, β€œAlone we can do so little; together we can do so much.” Your commitment to robust link checking directly improves the experience for every user and contributor, reinforcing the collaborative spirit that drives Ultralytics projects. Thank you for raising the bar and helping ensure our community enjoys seamless, reliable resources!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops GitHub Devops or MLops documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants