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

Enhanced GitHub Actions formatting workflow with AI-powered PR summaries.

📊 Key Changes

• 🧹 Unified branch naming in workflow triggers.
• 🤖 Introduced new AI-powered summary feature for PRs.
• 🔒 Added secret keys for AI summary integration.

🎯 Purpose & Impact

• 💡 Ensure consistent workflow activation across all branches.
• ✨ Automate generation of PR summaries, providing immediate context and insights.
• 🔗 Enhance PR review efficiency and understanding for developers and stakeholders.

[sourcery-ai]

PR Type: Enhancement

PR Summary: The pull request introduces enhancements to the Ultralytics Actions workflow by adding new formatting and validation features, including a PR summary feature utilizing OpenAI GPT-4. It aims to align the code and documentation with the latest Ultralytics official standards.

Decision: Comment

📝 Type: 'Enhancement' - not supported yet.

• Sourcery currently only approves 'Typo fix' PRs.

✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.

No details provided.

✅ Small diff: the diff is small enough to approve with confidence.

No details provided.

General suggestions:

• Verify that the 'markdown' option indeed supports formatting YAML files as indicated by the comments, to ensure the accuracy of the documentation.
• Clarify the requirements for the 'summary' option in the comments to reflect the actual secrets needed, whether it's just the Azure-related keys or if an 'openai_api_key' can also be used.
• Consider rephrasing the comment for the 'python' option to emphasize that the formatting applies to the entire Python codebase, including docstrings.

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

• X
• Mastodon
• LinkedIn
• Facebook

---

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.