ultralytics-actions 0.2.16

Ultralytics Actions for GitHub automation and PR management.

English | 简体中文

🚀 Ultralytics Actions

Welcome to Ultralytics Actions - a collection of GitHub Actions for automating code quality, PR management, and CI/CD workflows across Ultralytics projects.

📦 Repository Contents

This repository provides three main components:

1. Ultralytics Actions - Main GitHub Action for AI-powered code formatting, PR summaries, and auto-labeling
2. Standalone Actions - Reusable composite actions for common CI/CD tasks
3. Python Package - ultralytics-actions package for programmatic use

Ultralytics Actions (Main Action)

AI-powered formatting, labeling, and PR summaries for Python, Swift, Dart, and Markdown files.

📄 Features

• Python Code: Formatted using Ruff, an extremely fast Python linter and formatter
• Python Docstrings: Google-style formatting enforced with Ultralytics Python docstring formatter (optional)
• JavaScript/TypeScript: Formatted with Biome, an extremely fast formatter for JS, TS, JSX, TSX, and JSON (optional, auto-detected via biome.json)
• Web and Docs Files: Styled with Prettier for JS, TS, CSS, HTML, JSON, YAML, Markdown, and shell scripts
• Swift Code: Formatted with swift-format (requires macos-latest runner)
• Dart Code: Formatted with dart format for Dart and Flutter projects
• Spell Check: Common misspellings caught using codespell
• Broken Links Check: Broken links identified using Lychee
• PR Summary: Concise Pull Request summaries generated using AI
• PR Review: AI-powered code reviews identify critical bugs, security issues, and quality concerns with suggested fixes
• Auto-labeling: Applies relevant labels to issues, PRs, and discussions via AI

🤖 Supported AI Providers

Choose between OpenAI or Anthropic for AI-powered features:

Provider	Default Model	API Key
OpenAI	gpt-5.4	openai_api_key
Anthropic	claude-sonnet-4-6	anthropic_api_key

The model is auto-detected based on which API key you provide. Override with the model input, for example gpt-5.5, or use review_model to override PR review only.

🛠️ How It Works

Triggers on GitHub events to streamline workflows:

• Pull Requests: Ensures formatting standards, generates summaries, provides AI reviews, and applies labels
• Issues: Automatically applies relevant labels using AI
• Discussions: Automatically applies relevant labels using AI

🔧 Setup

Create .github/workflows/ultralytics-actions.yml:

# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license

# Ultralytics Actions https://github.com/ultralytics/actions
# This workflow formats code and documentation in PRs to Ultralytics standards

name: Ultralytics Actions

on:
  issues:
    types: [opened]
  discussion:
    types: [created]
  pull_request:
    branches: [main]
    types: [opened, closed, synchronize, review_requested]

permissions:
  contents: write # Modify code in PRs
  pull-requests: write # Add comments and labels to PRs
  issues: write # Add comments and labels to issues
  discussions: write # Add labels to discussions

jobs:
  actions:
    runs-on: ubuntu-latest
    steps:
      - name: Run Ultralytics Actions
        uses: ultralytics/actions@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }} # Auto-generated token
          labels: true # Auto-label issues/PRs using AI
          python-version: "3.14" # Optional: set up a specific Python version
          python: true # Format Python with Ruff
          python_docstrings: true # Format Python docstrings (default: true)
          biome: true # Format JS/TS with Biome (auto-detected via biome.json)
          prettier: true # Format YAML, JSON, Markdown, CSS
          swift: false # Format Swift (requires macos-latest)
          dart: false # Format Dart/Flutter
          spelling: true # Check spelling with codespell
          links: true # Check broken links with Lychee
          summary: true # Generate AI-powered PR summaries
          # AI API keys - provide OpenAI OR Anthropic (model auto-detected from key)
          openai_api_key: ${{ secrets.OPENAI_API_KEY }}
          # anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
          # model: gpt-5.5  # Optional: override default model
          # review_model: claude-opus-4-7  # Optional: override PR review model
          brave_api_key: ${{ secrets.BRAVE_API_KEY }} # Used for broken link resolution

Standalone Actions

Reusable composite actions for common CI/CD tasks. Each can be used independently in your workflows.

1. Retry Action

Retry failed commands with exponential backoff and jitter.

- uses: ultralytics/actions/retry@main
  with:
    run: npm install
    retries: 3
    timeout_minutes: 5

📖 Full Documentation →

2. Cleanup Disk Action

Free up disk space on GitHub runners by removing unnecessary packages and files.

- uses: ultralytics/actions/cleanup-disk@main

📖 Full Documentation →

3. Scan PRs Action

List open PRs across an organization and auto-merge eligible GitHub Actions update PRs.

- uses: ultralytics/actions/scan-prs@main
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    org: ultralytics # Optional: defaults to ultralytics
    visibility: private,internal # Optional: public, private, internal, all, or comma-separated

📖 Full Documentation →

4. Dependabot Action

Update GitHub Actions versions across organization repositories with cached release resolution.

- uses: ultralytics/actions/dependabot@main
  with:
    token: ${{ secrets.GITHUB_TOKEN }}

📖 Full Documentation →

Python Package

Install the ultralytics-actions package for programmatic access to action utilities, including all requirements, in a Python>=3.8 environment.

pip install ultralytics-actions

Available Modules:

• actions.review_pr - AI-powered PR review
• actions.summarize_pr - Generate PR summaries
• actions.scan_prs - Scan and manage organization PRs
• actions.first_interaction - Welcome message for new contributors
• And more in actions/ directory

💡 Contribute

Ultralytics thrives on community collaboration, and we deeply value your contributions! Please see our Contributing Guide for details on how you can get involved. We also encourage you to share your feedback through our Survey. A huge thank you 🙏 to all our contributors!

📄 License

Ultralytics offers two licensing options:

• AGPL-3.0 License: An OSI-approved open-source license ideal for students, researchers, and enthusiasts who value open collaboration. See the LICENSE file for details.
• Enterprise License: Designed for commercial use, this license allows integrating Ultralytics software and AI models into commercial products without AGPL-3.0's open-source requirements. For enterprise solutions, contact Ultralytics Licensing.

📫 Contact

For bug reports or feature suggestions related to Ultralytics Actions, please submit an issue via GitHub Issues. Join our Discord community for discussions and support!