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

Replace pre-commit with Ultralytics Actions #12570

Closed
wants to merge 4 commits into from
Closed

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 2, 2024

This pull request adds an improved Ultralytics Actions workflow to automatically format code and documentation to the new Ultralytics official standards maintained at https://github.com/ultralytics/actions.

Four individual actions are run by default. To disable actions, set them to false, i.e. 'python: false'.

To customize an action use a pyproject.toml file in this repo, and see the individual action repo for details.

name: Ultralytics Actions

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  format:
    runs-on: ubuntu-latest
    steps:
      - name: Run Ultralytics Formatting
        uses: ultralytics/actions@main
        with:
          python: true
          docstrings: true
          markdown: true
          spelling: true

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

WARNING ⚠️ this PR is very large, summary may not cover all changes.

🌟 Summary

Enhanced auto-formatting for code and documentation in PRs.

📊 Key Changes

  • Added automatic code formatting workflow for PRs.
  • Removed a previous pre-commit configuration.

🎯 Purpose & Impact

  • Ensures consistent coding standards.
  • Simplifies the code review process by automatically formatting PRs.
  • Helps maintain code quality and readability throughout the project.

@akx
Copy link
Contributor

akx commented Jan 3, 2024

@glenn-jocher, it would be quite lovely if you could first review and merge some of the open PRs in this repository (including #10970 which you've promised to get to any day now) before merging a PR that will necessarily require everyone to rebase theirs. Thank you for your consideration!

@glenn-jocher
Copy link
Member Author

@akx hello there! 👋

Thank you for bringing this to my attention. I understand the concern about the potential rebase requirement for open PRs due to the new formatting workflow. I'll prioritize reviewing the open PRs, including #10970, to ensure we can integrate these changes smoothly. Your patience and contributions are greatly appreciated by the Ultralytics team and the YOLO community!

Stay tuned for updates on the PRs, and feel free to reach out if you have any more questions or suggestions. Thanks again for your support! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants