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

Merged
merged 7 commits into from
May 1, 2023
Merged

Update links.yml #11463

merged 7 commits into from
May 1, 2023

Conversation

glenn-jocher
Copy link
Member

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

πŸ€– Generated by Copilot at a349cf1

Summary

πŸ“πŸ› οΈπŸ”

Improved the reliability and readability of the link checking workflow for the documentation. Used lychee instead of awesome_bot and added retries and comments in .github/workflows/links.yml.

To check links in the docs with lychee
We added a retry for more guarantee
And to make it more clear
We improved the comment here
So the workflow is easy to see

Walkthrough

  • Update the comment of the links.yml file to document the workflow and the status codes (link)
  • Replace the deprecated lychee-action with a custom installation of lychee and a retry action (link)
  • Exclude the ci.yaml file from the link checking (link)

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Improvements to Continuous Integration (CI) failure notifications and broken link checks in the Ultralytics GitHub workflow.

πŸ“Š Key Changes

  • Modified CI failure notification conditions to trigger only for 'ultralytics/yolov5' repository and on schedule or push events.
  • Updated the broken link checker to be more resilient by including retry logic and installing the latest lychee tool directly from GitHub releases.

🎯 Purpose & Impact

  • Enhanced Precision for Notifications: Failure notifications will be more targeted, reducing noise for contributors and maintainers. πŸ›ŽοΈ
  • Increased Reliability of Link Checks: The adoption of a retry strategy ensures that transient network issues don't cause unnecessary failure alerts. πŸ”„
  • Up-to-date Tooling: Using the latest version of lychee helps in accurate detection of broken links thanks to the latest features and fixes. πŸ†•

These changes can help maintain the quality of the repository by ensuring that contributors are only alerted for pertinent failures and that link integrity in documentation is reliably maintained.

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@glenn-jocher glenn-jocher merged commit 867f7f0 into master May 1, 2023
9 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch May 1, 2023 12:33
bandakopi pushed a commit to irajcode/yolov5 that referenced this pull request Jul 20, 2023
* Update links.yml

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update links.yml

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update ci-testing.yml

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update links.yml

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update links.yml

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update ci-testing.yml

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* updates

---------

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