Skip to content

Add Permissions to Ultralytics Actions format.yml#17

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

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

Conversation

@glenn-jocher
Copy link
Copy Markdown
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 and expands the automated workflow for formatting code, documentation, and managing PRs using Ultralytics Actions. 🚀🤖

📊 Key Changes

  • Updates the GitHub Actions workflow to use a more comprehensive "Ultralytics Actions" job.
  • Adds explicit permissions for modifying code, PRs, and issues.
  • Enhances formatting steps:
    • Uses Ruff and docformatter for Python code.
    • Uses codespell for spell checking.
    • Adds support for AI-powered PR summaries, labels, and comments.
    • Integrates Brave API for improved broken link resolution.
  • Clarifies and updates documentation within the workflow file.

🎯 Purpose & Impact

  • Ensures all code and documentation in PRs meet Ultralytics standards automatically.
  • Reduces manual review effort by auto-formatting and labeling PRs.
  • Improves PR summaries and feedback using AI, making contributions easier to understand.
  • Enhances quality control and consistency across the codebase.
  • Speeds up the review process for both contributors and maintainers.

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

👋 Hello @glenn-jocher, thank you for submitting an ultralytics/source-trace 🚀 PR! This is an automated response to help streamline the review process—an Ultralytics engineer will also review your contribution soon.

Please review the following checklist to ensure your PR can be integrated smoothly:

  • 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 the project's conventions.
  • Synchronize with Source: Make sure your PR is up to date with the ultralytics/source-trace main branch. If your branch is behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • Ensure CI Checks Pass: Confirm all Ultralytics Continuous Integration (CI) checks pass. Please address any failing checks.
  • Update Documentation: Update the relevant documentation for any new or modified workflows or features.
  • Add Tests: If applicable, add or update tests to cover your changes and ensure all tests pass.
  • Sign the CLA: If this is your first Ultralytics PR, please sign our Contributor License Agreement (CLA) by commenting "I have read the CLA Document and I sign the CLA".
  • Minimize Changes: Keep your changes to the minimum necessary for your enhancement or fix. "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, please see our Contributing Guide. If you have any questions, feel free to leave a comment below.

Thank you for helping improve Ultralytics! 🚀🤖

@glenn-jocher glenn-jocher merged commit 52b5e2f into main May 11, 2025
3 checks passed
@glenn-jocher glenn-jocher deleted the update-format-workflow-20250511015703 branch May 11, 2025 00:21
@UltralyticsAssistant
Copy link
Copy Markdown
Member

🎉 Fantastic work, @glenn-jocher! Your improvements to our automated workflows are a huge step forward in ensuring quality and efficiency across the project. As Henry Ford said, “If everyone is moving forward together, then success takes care of itself.” Your contributions help us move forward as a team, making it easier for everyone to contribute and for our codebase to shine. Thank you for driving innovation and raising the bar for excellence in Ultralytics projects! 🚀

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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants