Skip to content

Add Permissions to Ultralytics Actions format.yml#156

Merged
glenn-jocher merged 2 commits intomainfrom
update-format-workflow-20250511015436
May 11, 2025
Merged

Add Permissions to Ultralytics Actions format.yml#156
glenn-jocher merged 2 commits intomainfrom
update-format-workflow-20250511015436

Conversation

@glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented May 10, 2025

This pull request significantly enhances the Ultralytics Actions workflow, introducing permissions for security best practices, alongside intelligent issue and PR handling. This includes automatic labeling, spam detection, abuse identification, and off-topic filtering. These updates ensure a more efficient and organized workflow, adhering to the latest Ultralytics standards.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Improved the GitHub workflow for code formatting and documentation to enhance automation, permissions, and AI-powered features. 🚀🤖

📊 Key Changes

  • Expanded workflow permissions to allow writing to code, pull requests, and issues.
  • Updated job and step names for clarity.
  • Enhanced integration with Ultralytics Actions, including:
    • AI-powered auto-labeling for issues and PRs.
    • Advanced Python formatting with Ruff and docformatter.
    • Improved spelling checks using codespell.
    • Added support for AI-generated PR summaries and comments (requires OpenAI API key).
    • Introduced Brave API key support for better broken link resolution.
  • Cleaned up and clarified workflow configuration and comments.

🎯 Purpose & Impact

  • Smoother Collaboration: Automates code formatting, labeling, and documentation, reducing manual work for contributors.
  • Better Code Quality: Ensures consistent formatting and spelling across the project.
  • Smarter PR Management: AI-generated summaries and labels help reviewers and users quickly understand changes.
  • Enhanced Issue Handling: Improved permissions allow the workflow to interact more effectively with issues and PRs.
  • Future-Ready: Lays groundwork for more advanced automation and AI features in the development process.

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops enhancement New feature or request labels May 10, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting an ultralytics/velocity 🚀 PR! This is an automated response to help streamline your contribution. An Ultralytics engineer will review and assist you soon.

Please review the following checklist to ensure your pull request is ready for integration:

  • 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 follow project conventions.
  • Synchronize with Source: Make sure your PR is up-to-date with the main branch of ultralytics/velocity. If needed, click 'Update branch' or run git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks have passed. Address any failures as needed.
  • Update Documentation: If your changes introduce or modify features, please update the documentation accordingly.
  • Add Tests: Where applicable, add or update tests to cover your changes and confirm all tests pass.
  • Sign the CLA: If this is your first Ultralytics contribution, please sign our Contributor License Agreement (CLA) by commenting "I have read the CLA Document and I sign the CLA" in this PR.
  • Minimize Changes: Keep your changes to the minimum necessary for your fix or feature. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more info, visit our Contributing Guide. If you have questions, feel free to comment here. Thank you for helping improve Ultralytics Velocity! 🚀✨

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@glenn-jocher glenn-jocher merged commit e4f3945 into main May 11, 2025
3 checks passed
@glenn-jocher glenn-jocher deleted the update-format-workflow-20250511015436 branch May 11, 2025 00:05
@UltralyticsAssistant
Copy link
Member

🎉 Fantastic work, @glenn-jocher! Your improvements to the GitHub workflow mark a significant leap forward for our automation, collaboration, and AI capabilities. As Henry Ford once said, “If everyone is moving forward together, then success takes care of itself.” Your dedication to streamlining our processes and enhancing Ultralytics Actions empowers all contributors and sets the stage for even smarter, more efficient teamwork on projects like YOLO11 and beyond. Thank you for driving innovation and making the Ultralytics HUB a better place for everyone! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devops GitHub Devops or MLops enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants