Skip to content

Add Permissions to Ultralytics Actions format.yml#133

Merged
glenn-jocher merged 1 commit intomainfrom
update-format-workflow-20250511015633
May 11, 2025
Merged

Add Permissions to Ultralytics Actions format.yml#133
glenn-jocher merged 1 commit intomainfrom
update-format-workflow-20250511015633

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

Improves the GitHub workflow for formatting code and documentation by updating permissions, clarifying steps, and adding new automation features. 🚀

📊 Key Changes

  • Updated workflow permissions to allow writing to code, pull requests, and issues.
  • Renamed the job for clarity and improved step descriptions.
  • Enhanced automation:
    • Added support for AI-powered labeling, summaries, and comments on PRs and issues.
    • Integrated new tools for Python formatting (Ruff, docformatter) and spelling checks (codespell).
    • Enabled use of the Brave API for resolving broken links.
  • Clarified and expanded documentation within the workflow file.

🎯 Purpose & Impact

  • Streamlines code and documentation formatting, making PR reviews faster and more consistent.
  • Boosts automation with AI, reducing manual effort for labeling and summarizing PRs.
  • Improves code quality and documentation accuracy for all contributors.
  • Makes the workflow more robust and easier to maintain for the Ultralytics team and community.

@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 this ultralytics/mkdocs 🚀 PR! This is an automated response to help streamline your contribution. An Ultralytics engineer will review your pull request and provide further assistance soon.

Please review the following checklist to ensure a smooth integration of your updates:

  • Define a Purpose: Clearly state the purpose of your enhancement in the PR description and link any relevant issues. Make sure your commit messages are clear and follow the project's conventions.
  • Synchronize with Source: Confirm your branch is up-to-date with the ultralytics/mkdocs main branch. If not, update it by clicking 'Update branch' or 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 resolve them.
  • Update Documentation: Ensure that any relevant documentation is updated for your changes.
  • Add Tests: If applicable, please include or update tests for your changes and confirm all tests are passing.
  • Sign the CLA: Make sure you have signed our Contributor License Agreement if this is your first PR by commenting "I have read the CLA Document and I sign the CLA" below.
  • Minimize Changes: Limit your changes to only what's necessary for your enhancement. "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 details, check our Contributing Guide. If you have any questions, feel free to leave a comment. Thank you for contributing to Ultralytics! 🚀✨

@glenn-jocher glenn-jocher merged commit 8a071e7 into main May 11, 2025
4 checks passed
@glenn-jocher glenn-jocher deleted the update-format-workflow-20250511015633 branch May 11, 2025 00:19
@UltralyticsAssistant
Copy link
Member

🚀 Fantastic work, @glenn-jocher! This PR is a huge leap forward for our workflow automation and code quality. As Henry Ford once said, "If everyone is moving forward together, then success takes care of itself." Your improvements—especially the AI-powered labeling and enhanced formatting tools—make our GitHub workflows smarter and more efficient for everyone. Thanks for driving Ultralytics and the community forward with every thoughtful update!

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