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

Enhancements to the GitHub Actions workflow for automated code formatting and PR summarization.

📊 Key Changes

• Updated the trigger from pull_request_target to pull_request for workflow activation.
• Added a new functionality to print PR summaries using GPT-4 automation.
• Introduced requirements for openai_api_key or openai_azure_api_key and openai_azure_endpoint for the new summary feature.

🎯 Purpose & Impact

• 🎉 Improves the security model for actions triggered by pull requests.
• 🤖 Provides automated, AI-generated summaries for pull requests, potentially increasing productivity.
• 💡 Enhances the code review process with summaries that help developers and stakeholders quickly understand PR changes.
• 🔐 Ensures secure handling of the new feature by requiring appropriate secret keys.

[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 generated by OpenAI GPT-4. The changes aim to improve code and documentation quality according to the official Ultralytics 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:

• Review the security implications of changing the event trigger from pull_request_target to pull_request to ensure that no unintended permissions or data exposures occur.
• Consider the cost implications and potential for abuse with the integration of OpenAI GPT-4 for PR summaries, and implement necessary safeguards.
• Clarify the functionality of the 'markdown' option if it also formats YAML, to ensure that the naming and comments are not misleading.

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.

[sourcery-ai]

issue (llm): Changing from pull_request_target to pull_request alters the permissions and event context. Ensure that this change doesn't introduce any security vulnerabilities, especially if the workflow uses the GITHUB_TOKEN or other secrets in the context of a pull request from a fork.

[sourcery-ai]

question (llm): The addition of GPT-4 summary generation is an interesting feature. However, it's important to consider the potential costs associated with the OpenAI API usage and ensure that there are checks in place to prevent abuse or excessive use.

[sourcery-ai]

suggestion (llm): The comment '# format Markdown and YAML' might be misleading as the option name 'markdown' suggests it's only for Markdown. If it indeed formats YAML, consider renaming the option to reflect both formats or updating the comment to avoid confusion.