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

Merged
merged 1 commit into from
Jan 30, 2025
Merged

Update links.yml #13503

merged 1 commit into from
Jan 30, 2025

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 30, 2025

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced GitHub workflow to improve visibility of link-check results by appending them to the GitHub Actions summary. πŸ“‹βœ¨

πŸ“Š Key Changes

  • Modified the links.yml workflow to pipe the results of link-checking scripts (tee -a $GITHUB_STEP_SUMMARY) directly into the GitHub Actions summary.

🎯 Purpose & Impact

  • Improved Transparency: Makes link-check results more visible and accessible by including them in the GitHub Actions summary, reducing the need to dig through raw logs.
  • Simpler Debugging: Helps developers quickly identify and address link issues, saving time during development. πŸš€
  • User Convenience: Streamlines workflows for contributors, improving the overall development experience.

Signed-off-by: Glenn Jocher <[email protected]>
@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Jan 30, 2025
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting a ultralytics/yolov5 πŸš€ PR! To ensure a seamless integration of your work, 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, concise, and adhere to the project's conventions.
  • βœ… Synchronize with Source: Confirm your PR is synchronized with the ultralytics/yolov5 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

If your PR introduces new workflows or improvements, it’s highly recommended to test them in a development branch first to ensure seamless integration into the main pipeline. 🚦

For more guidance, please refer to our Contributing Guide. Don’t hesitate to leave a comment if you have any questions. An Ultralytics engineer will review your PR and provide further assistance shortly. Thank you for contributing to Ultralytics! πŸš€

@glenn-jocher glenn-jocher merged commit 5cdad89 into master Jan 30, 2025
10 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch January 30, 2025 16:42
@UltralyticsAssistant
Copy link
Member

πŸŽ‰ Woohoo! Your PR has been merged, @glenn-jocher!

"Details create the big picture." – Sanford I. Weill.

By enhancing the GitHub workflow to highlight link-check results, you’ve not only improved visibility but also empowered smoother collaboration and debugging for everyone. This thoughtful improvement will make a huge difference for developers by saving time and enhancing clarity. πŸš€

Thank you for always driving innovation and excellence in the project. Your dedication inspires us all! πŸ™Œ

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