🚀 Ultralytics Actions: Auto-Formatting for Python and Markdown

Welcome to the Ultralytics Actions repository, your go-to solution for maintaining consistent code quality across Ultralytics Python projects. This GitHub Action is designed to automate the formatting of Python and Markdown files, ensuring adherence to our coding standards.

📄 Actions Description

Ultralytics Actions automatically applies formats and updates:

• Python Code: Using Ruff, a fast Python auto-formatter.
• Markdown Files: With mdformat, ensuring a consistent style in documentation.
• Docstrings: Utilizing docformatter for clean and standardized documentation comments.
• Spell Check: Employing codespell for catching common misspellings.
• Broken Links Check: Implementing Lychee to report broken links in docs and markdown files.
• PR Summary: Generating concise OpenAI GPT4-powered PR summaries, enhancing PR clarity.

🛠 How It Works

Upon integration, Ultralytics Actions triggers on:

• Push Events: Automatically formats code when changes are pushed to the main branch.
• Pull Requests: Ensures that contributions meet our formatting standards before merging.

🔧 Setting Up the Action

To use this action in your Ultralytics repository:

1. Create a Workflow File: In your repository, create a file under .github/workflows/, e.g., ultralytics-actions.yml.

2. Add the Action: Use the Ultralytics Actions in your workflow file as follows:

   name: Ultralytics Actions
   
   on:
     push:
       branches: [main]
     pull_request:
       branches: [main]
       types: [opened, closed, synchronize]
   
   jobs:
     format:
       runs-on: ubuntu-latest
       steps:
         - name: Run Ultralytics Formatting
           uses: ultralytics/actions@main
           with:
             token: ${{ secrets.GITHUB_TOKEN }} # automatically generated, do not modify
             python: true # format Python code and docstrings
             markdown: true # format Markdown and YAML
             spelling: true # check spelling
             links: true # check broken links
             summary: true  # print PR summary with GPT4 (requires 'openai_api_key' or 'openai_azure_api_key' and 'openai_azure_endpoint')
             openai_api_key: # your OpenAI API key

3. Customize: Adjust the workflow settings as necessary for your project.

💡 Contribute

Ultralytics thrives on community collaboration; we immensely value your involvement! We urge you to peruse our Contributing Guide for detailed insights on how you can participate. Don't forget to share your feedback with us by contributing to our Survey. A heartfelt thank you 🙏 goes out to everyone who has already contributed!

📄 License

Ultralytics presents two distinct licensing paths to accommodate a variety of scenarios:

• AGPL-3.0 License: This official OSI-approved open-source license is perfectly aligned with the goals of students, enthusiasts, and researchers who believe in the virtues of open collaboration and shared wisdom. Details are available in the LICENSE document.
• Enterprise License: Tailored for commercial deployment, this license authorizes the unfettered integration of Ultralytics software and AI models within commercial goods and services, without the copyleft stipulations of AGPL-3.0. Should your use case demand an enterprise solution, direct your inquiries to Ultralytics Licensing.

📮 Contact

For bugs or feature suggestions pertaining to Ultralytics, please lodge an issue via GitHub Issues. You're also invited to participate in our Discord community to engage in discussions and seek advice!