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 #11526

Merged
merged 1 commit into from
May 14, 2023
Merged

Update links.yml #11526

merged 1 commit into from
May 14, 2023

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented May 13, 2023

πŸ€– Generated by Copilot at d2b1394

Summary

πŸ› οΈπŸš«πŸ”—

This pull request improves the link checker workflow by allowing manual triggers, reducing false positives, and excluding irrelevant domains and files.

To avoid false alarms and frustration
We updated the link checker workflow
Now it runs on demand with some exclusion
Of domains and files that we know
Are valid and don't need to be checked so

Walkthrough

  • Remove workflow triggers on push and pull request events to master branch, and enable manual trigger by workflow_dispatch event (link)
  • Adjust link checker command to accept only 429 and 999 status codes, and exclude links from twitter.com, instagram.com and url.com (link, link)
  • Simplify exclude-path argument for link checker command by using glob pattern instead of listing each file (link)

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Improved link-checking workflow in GitHub repository.

πŸ“Š Key Changes

  • Removed link-checking on each push and pull request to master branch.
  • Updated the lychee link checker command options:
    • Changed accepted HTTP statuses to only include 429 and 999.
    • Expanded the exclusion list to include Instagram links in addition to Twitter.

🎯 Purpose & Impact

  • Reduces unnecessary workflow runs: Not running link checks on every push or pull request can save CI resources and reduce notification noise.
  • Streamlined link-checking: By limiting accepted statuses, the check focuses on more critical link issues, enhancing the relevance of the workflow.
  • Prevents false positives: Excluding certain domains like Instagram ensures that the link checker doesn't fail due to specific site restrictions or behaviors, leading to more accurate CI outcomes for documentation quality.

The changes should make the repository maintenance more efficient and the link-check status more actionable for maintainers and contributors. πŸš€

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@glenn-jocher glenn-jocher merged commit 54e9515 into master May 14, 2023
10 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch May 14, 2023 00:35
bandakopi pushed a commit to irajcode/yolov5 that referenced this pull request Jul 20, 2023
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
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.

None yet

1 participant