🚀 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:
- Ultralytics Actions - Main GitHub Action for AI-powered code formatting, PR summaries, and auto-labeling
- Standalone Actions - Reusable composite actions for common CI/CD tasks
- Python Package -
ultralytics-actionspackage for programmatic use
Ultralytics Actions (Main Action)
AI-powered formatting, labeling, and PR summaries for Python, JavaScript/TypeScript, Swift, Dart, and web/docs 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.jsonorbiome.jsonc) - Web and Docs Files: Styled with Prettier for JS, TS, CSS, HTML, JSON, YAML, Markdown, and shell scripts
- Swift Code: Formatted with
swift-format(requiresmacos-latestrunner) - Dart Code: Formatted with
dart formatfor 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.6-luna |
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, 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: true # Format Python with Ruff
# python-version: "3.14" # Optional: set up a specific Python version (default: runner Python)
python_docstrings: true # Format Python docstrings (default: true)
biome: true # Format JS/TS with Biome (auto-detected via biome.json or biome.jsonc)
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.6-luna # Optional: set model explicitly
# 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
2. Cleanup Disk Action
Free up disk space on GitHub runners by removing unnecessary packages and files.
- uses: ultralytics/actions/cleanup-disk@main
3. GitHub Report Action
Summarize open PRs and failed default-branch GitHub Actions across organization repositories.
- uses: ultralytics/actions/github-report@main
with:
token: ${{ secrets.GITHUB_TOKEN }}
org: ultralytics # Optional: defaults to ultralytics
visibility: all # Optional: public, private, internal, all, or comma-separated
auto_merge_actions_prs: true # Optional: auto-merge eligible GitHub Actions update PRs
4. Dependabot Action
Update GitHub Actions versions across organization repositories with cached release resolution.
- uses: ultralytics/actions/dependabot@main
with:
token: ${{ secrets.GITHUB_TOKEN }}
5. CLA Action
Check every pull request commit author against the central Ultralytics CLA signature ledger.
- uses: ultralytics/actions/cla@main
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
cla-token: ${{ secrets._GITHUB_TOKEN }}
6. Setup uv Action
Install the latest uv with retry support and optionally activate a Python environment.
- uses: ultralytics/actions/setup-uv@main
with:
python-version: "3.14"
activate-environment: true
Python Package
Install the ultralytics-actions package for programmatic access to action utilities, including all requirements, in a Python>=3.8 environment.
uv pip install ultralytics-actions
Available Modules:
actions.review_pr- AI-powered PR reviewactions.summarize_pr- Generate PR summariesactions.github_report- Generate GitHub organization reportsactions.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!
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ultralytics_actions-0.2.29.tar.gz.
File metadata
- Download URL: ultralytics_actions-0.2.29.tar.gz
- Upload date:
- Size: 120.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
02a65c3b3baaaaee9a0dd37ac095460cc6609d4fcc388c65317e700ab25cf27d
|
|
| MD5 |
ea6f7c587f89a5662424b3c9556d13de
|
|
| BLAKE2b-256 |
ce7e0dcce2e0d03e96b04fb93e851e20aef84874f22ad9250458f2525742eaac
|
Provenance
The following attestation bundles were made for ultralytics_actions-0.2.29.tar.gz:
Publisher:
publish.yml on ultralytics/actions
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ultralytics_actions-0.2.29.tar.gz -
Subject digest:
02a65c3b3baaaaee9a0dd37ac095460cc6609d4fcc388c65317e700ab25cf27d - Sigstore transparency entry: 2189828617
- Sigstore integration time:
-
Permalink:
ultralytics/actions@ea569b164d8f4e6014f8b74ace80cb626fbf72f7 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/ultralytics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ea569b164d8f4e6014f8b74ace80cb626fbf72f7 -
Trigger Event:
push
-
Statement type:
File details
Details for the file ultralytics_actions-0.2.29-py3-none-any.whl.
File metadata
- Download URL: ultralytics_actions-0.2.29-py3-none-any.whl
- Upload date:
- Size: 98.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2d176efba9124e52e51c5557513331583d571bf84bcdc055d8bbcb3a69723f4c
|
|
| MD5 |
582b1e353fc477fa4b871e86dd59c3df
|
|
| BLAKE2b-256 |
0ccdb8e74650782f6f1850032b2bd23c674d5e911483aed0a282527843bc71e4
|
Provenance
The following attestation bundles were made for ultralytics_actions-0.2.29-py3-none-any.whl:
Publisher:
publish.yml on ultralytics/actions
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ultralytics_actions-0.2.29-py3-none-any.whl -
Subject digest:
2d176efba9124e52e51c5557513331583d571bf84bcdc055d8bbcb3a69723f4c - Sigstore transparency entry: 2189828634
- Sigstore integration time:
-
Permalink:
ultralytics/actions@ea569b164d8f4e6014f8b74ace80cb626fbf72f7 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/ultralytics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ea569b164d8f4e6014f8b74ace80cb626fbf72f7 -
Trigger Event:
push
-
Statement type:
