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

Merged
merged 1 commit into from
Jan 30, 2025
Merged

Update links.yml #2316

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 log link-checking results directly into the workflow summary output. πŸ› οΈπŸ“‹

πŸ“Š Key Changes

  • Added tee -a $GITHUB_STEP_SUMMARY to the link-checking steps for .html and .ipynb files.

🎯 Purpose & Impact

  • Purpose: This change ensures that the results of the link-checking process are readily available in the workflow summary, improving visibility and debugging convenience.
  • Impact: Users and maintainers can quickly access link-validation results directly from workflow summary logs, streamlining the review process and reducing the need to dig through raw logs. πŸ–₯οΈβœ…

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 an ultralytics/yolov3 πŸš€ 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/yolov3 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

It looks like you've submitted a workflow enhancement β€” fantastic work! πŸŽ‰ If there are any additional linked issues, please ensure they are referenced in your PR for context. Additionally, double-check that all steps in the new workflow continue to meet the expected output requirements.

For more guidance, please refer to our Contributing Guide. Don’t hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! πŸš€

⚠️ Note: This is an automated response. An Ultralytics engineer will review your PR shortly and provide further feedback if required. 😊

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

πŸŽ‰ Huge thanks for this awesome contribution, @glenn-jocher! Your enhancement to the workflow logging is a brilliant step forward in making development smoother and more transparent for everyone. πŸ™Œ

As Benjamin Franklin aptly said, "An investment in knowledge always pays the best interest." πŸ§ πŸ”§ Your thoughtful addition to log link-checking results directly into the workflow summary invests in clarity and efficiency, making life easier for both users and maintainers.

We truly appreciate your continuous dedication to improving Ultralytics projectsβ€”thank you for making an impact that goes beyond just the code! πŸš€πŸ’‘

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