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

Update Ultralytics Actions with OpenAI GPT-4 PR Summary #16

Merged
merged 1 commit into from
Jan 28, 2024

Conversation

pderrenger
Copy link
Member

@pderrenger pderrenger commented Jan 28, 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.

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

GitHub PR formatting workflow updated to include AI-generated summaries.

📊 Key Changes

  • Trigger for the formatting workflow changed from pull_request_target to pull_request.
  • Added 'summary' option to print PR summaries using GPT-4.
  • Configured use of the Ultralytics formatting action with additional API key and endpoint parameters for AI summarization.

🎯 Purpose & Impact

  • 🛠 Improves security by using the pull_request trigger, which runs actions in the context of the PR, not the base repository.
  • 🤖 Integrates AI to generate concise summaries for PRs, enhancing clarity and understanding of changes, making reviews easier and more effective.
  • 💡 Potentially impacts PR discussions by providing an AI-powered overview, facilitating better communication among developers and non-technical stakeholders.
  • 🔒 Requires secure handling of new secrets for AI API keys, indicating a focus on both enhancement and security.

@glenn-jocher glenn-jocher merged commit f1e9cf0 into master Jan 28, 2024
2 checks passed
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240128211135 branch January 28, 2024 20:23
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.

2 participants