Ultralytics Actions with OpenAI GPT-4 PR Summary

[pderrenger]

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.

Six individual actions are run by default now including a new PR Summary utilizing OpenAI GPT-4. Disable individual actions by setting them to false or removing their line, i.e. delete 'markdown: true' line to disable markdown formatting.

Note that additional spellings have been added to the Ultralytics spelling dictionary and frontmatter is now ignored by markdown formatters per your feedback.

To customize an action use a pyproject.toml file in this repo. For details see https://github.com/ultralytics/actions.

# Ultralytics 🚀 - AGPL-3.0 license
# Ultralytics Actions https://github.com/ultralytics/actions
# This workflow automatically formats code and documentation in PRs to official Ultralytics standards

name: Ultralytics Actions

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

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_azure_api_key: ${{ secrets.OPENAI_AZURE_API_KEY }}
          openai_azure_endpoint: ${{ secrets.OPENAI_AZURE_ENDPOINT }}

🛠️ PR Summary

_{Made with ❤️ by Ultralytics Actions}

🌟 Summary

Enhancement of the GitHub Actions formatting workflow in the ultralytics/yolov5 repository.

📊 Key Changes

• Modified branch references to remove space, using main,master instead of main, master.
• Changed hook from pull_request_target to pull_request.
• Expanded the workflow to include automatic PR summarization with GPT-4.
• Added summary option to trigger PR summaries.
• Integrated openai_azure_api_key and openai_azure_endpoint secrets to support the new summarization feature.

🎯 Purpose & Impact

• Ensures consistent branch reference formatting, potentially improving workflow triggers.
• Transition to pull_request hook can streamline how PRs are handled and improve security.
• The new PR summary feature, powered by GPT-4, aims to provide concise and informative summaries, enhancing the review process.
• Users can expect more comprehensive automated checks and convenience in understanding PR content, which can lead to faster and more efficient collaboration. 🤖✨