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

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

Improved GitHub actions formatting with GPT-4 summary generation 📝✨

📊 Key Changes

  • Added a feature to print PR summaries using GPT-4 in the formatting workflow 🤖
  • Included new workflow inputs for the openai_azure_api_key and openai_azure_endpoint secrets 🔑
  • Made minor clarifications in comments for existing options in the workflow file 📝

🎯 Purpose & Impact

  • Enables automated, AI-powered summarization of PRs to aid in understanding changes quickly 🚀
  • Supports developers by providing concise, intelligible descriptions of PR content, enhancing collaboration and review processes 🤝
  • Leverages OpenAI's GPT-4, indicating a step towards more intelligent automation within the repository's workflows 🧠

Remember to add the required Azure API keys and endpoints as GitHub secrets to activate the new summary feature!

@glenn-jocher glenn-jocher merged commit 27f6015 into master Jan 28, 2024
2 checks passed
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240128211254 branch January 28, 2024 22:39
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.

None yet

2 participants