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 #15

Closed
wants to merge 1 commit into from

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: false # 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 PR Formatting Workflow with GPT-4 Summary Generation 🛠️✨

📊 Key Changes

  • 🤖 A new feature for PR summary generation using GPT-4 has been added.
  • 🚫 Broken link checking in PRs has been disabled.
  • 🔑 Addition of secrets for OPENAI_AZURE_API_KEY and OPENAI_AZURE_ENDPOINT to facilitate GPT-4 integration.

🎯 Purpose & Impact

  • The GPT-4 summary feature will automatically generate readable summaries for PRs, aiding in clarity and understanding for both developers and non-technical stakeholders. 🧠💡
  • Disabling broken link checking may streamline the formatting workflow, potentially speeding up the process. 🚀
  • Integrating with OpenAI's Azure endpoint ensures secure and reliable access to the GPT-4 API, enhancing the automation capabilities of the repo's workflows. 🔒🌐

@glenn-jocher glenn-jocher deleted the update-format-workflow-20240128211046 branch January 28, 2024 20:12
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