Skip to content
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

Update links.yml #12

Merged
merged 5 commits into from
Nov 3, 2023
Merged

Update links.yml #12

merged 5 commits into from
Nov 3, 2023

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Nov 3, 2023

copilot:all

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced GitHub Actions configuration for improved link checking in the documentation.

πŸ“Š Key Changes

  • Updated the broken link checker to ignore additional HTTP status codes (403, 500, 502) that lead to false positives.
  • Condensed redundant link check commands within GitHub Actions into more efficient configurations.
  • Ensured that a wider range of file types (Markdown, HTML, YAML, Python, and Jupyter Notebooks) are included in link checking on manual trigger (workflow_dispatch).

🎯 Purpose & Impact

  • Minimizing False Alarms: By ignoring certain error codes like 403 (Forbidden), 500 (Internal Server Error), and 502 (Bad Gateway), the CI process reduces noise from transient network or server issues that are not actual broken links.
  • Streamlining CI Processes: The update leads to a cleaner and more maintainable GitHub Actions workflow, saving processing time and resources.
  • Comprehensive Link Verification: Expanding file type coverage ensures that links in documentation and code notebooks are also verified, leading to higher overall documentation quality.

This update improves the reliability and efficiency of documentation quality checks, allowing developers and users to trust the links and resources provided in Ultralytics documentation.

@glenn-jocher glenn-jocher merged commit 2cd3d9b into main Nov 3, 2023
1 of 3 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch November 3, 2023 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant