<a href="https://www.ultralytics.com/" target="_blank"><img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320" alt="Ultralytics logo"></a>
# 🚀 Ultralytics Actions: Auto-Formatting for Python, Markdown, and Swift
Welcome to the [Ultralytics Actions](https://github.com/ultralytics/actions) repository, your go-to solution for maintaining consistent code quality across Ultralytics Python and Swift projects. This GitHub Action is designed to automate the formatting of Python, Markdown, and Swift files, ensuring adherence to our coding standards.
[](https://github.com/marketplace/actions/ultralytics-actions) [](https://github.com/ultralytics/actions/actions/workflows/format.yml) <a href="https://discord.com/invite/ultralytics"><img alt="Discord" src="https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue"></a> <a href="https://community.ultralytics.com/"><img alt="Ultralytics Forums" src="https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue"></a> <a href="https://reddit.com/r/ultralytics"><img alt="Ultralytics Reddit" src="https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue"></a>
[](https://badge.fury.io/py/ultralytics-actions) [](https://pepy.tech/project/ultralytics-actions)
## 📄 Actions Description
Ultralytics Actions automatically applies formats, updates, and enhancements:
- **Python Code:** Using [Ruff](https://github.com/astral-sh/ruff), a fast Python auto-formatter.
- **Markdown Files:** With [Prettier](https://github.com/prettier/prettier), ensuring a consistent style in documentation.
- **Docstrings:** Utilizing [docformatter](https://github.com/PyCQA/docformatter) for clean and standardized documentation comments.
- **Swift Code:** Formatting Swift files using `swift-format` to ensure consistent coding style across Swift projects. _(Requires `macos-latest` to run correctly.)_
- **Spell Check:** Employing [codespell](https://github.com/codespell-project/codespell) for catching common misspellings.
- **Broken Links Check:** Implementing [Lychee](https://github.com/lycheeverse/lychee) to report broken links in docs and markdown files.
- **PR Summary:** Generating concise [OpenAI](https://openai.com/) GPT4o-powered PR summaries, enhancing PR clarity.
- **Auto-labeling:** Applying relevant labels to issues and pull requests using [OpenAI](https://openai.com/) GPT-4o for intelligent categorization.
## 🛠 How It Works
Ultralytics Actions triggers on various GitHub events:
- **Push Events:** Automatically formats code when changes are pushed to the `main` branch.
- **Pull Requests:**
- Ensures that contributions meet our formatting standards before merging.
- Generates a concise summary of the changes using GPT-4o.
- Automatically applies relevant labels using GPT-4o for intelligent categorization.
- **Issues:** Automatically applies relevant labels using GPT-4o when new issues are created.
These actions help maintain code quality, improve documentation clarity, and streamline the review process by providing consistent formatting, informative summaries, and appropriate categorization of issues and pull requests.
## 🔧 Setting Up the Action
To use this action in your Ultralytics repository:
1. **Create a Workflow File:** In your repository, create a file under `.github/workflows/`, e.g., `ultralytics-actions.yml`.
2. **Add the Action:** Use the Ultralytics Actions in your workflow file as follows:
```yaml
name: Ultralytics Actions
on:
issues:
types: [opened]
pull_request:
branches: [main]
types: [opened, closed]
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
labels: true # autolabel issues and PRs
python: true # format Python code and docstrings
prettier: true # format YAML, JSON, Markdown and CSS
swift: true # format Swift code (requires 'macos-latest')
spelling: true # check spelling
links: true # check broken links
summary: true # print PR summary with GPT4o (requires 'openai_api_key')
openai_api_key: # your OpenAI API key
```
3. **Customize:** Adjust the workflow settings as necessary for your project.
## 💡 Contribute
Ultralytics thrives on community collaboration; we immensely value your involvement! We urge you to peruse our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for detailed insights on how you can participate. Don't forget to share your feedback with us by contributing to our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A heartfelt thank you 🙏 goes out to everyone who has already contributed!
<a href="https://github.com/ultralytics/yolov5/graphs/contributors">
<img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/image-contributors.png" alt="Ultralytics open-source contributors"></a>
## 📄 License
Ultralytics presents two distinct licensing paths to accommodate a variety of scenarios:
- **AGPL-3.0 License**: This official [OSI-approved](https://opensource.org/license) open-source license is perfectly aligned with the goals of students, enthusiasts, and researchers who believe in the virtues of open collaboration and shared wisdom. Details are available in the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) document.
- **Enterprise License**: Tailored for commercial deployment, this license authorizes the unfettered integration of Ultralytics software and AI models within commercial goods and services, without the copyleft stipulations of AGPL-3.0. Should your use case demand an enterprise solution, direct your inquiries to [Ultralytics Licensing](https://www.ultralytics.com/license).
## 📮 Contact
For bugs or feature suggestions pertaining to Ultralytics, please lodge an issue via [GitHub Issues](https://github.com/ultralytics/pre-commit/issues). You're also invited to participate in our [Discord](https://discord.com/invite/ultralytics) community to engage in discussions and seek advice!
<br>
<div align="center">
<a href="https://github.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="Ultralytics GitHub"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://www.linkedin.com/company/ultralytics/"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="3%" alt="Ultralytics LinkedIn"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://twitter.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="3%" alt="Ultralytics Twitter"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://youtube.com/ultralytics?sub_confirmation=1"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png" width="3%" alt="Ultralytics YouTube"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://www.tiktok.com/@ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png" width="3%" alt="Ultralytics TikTok"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://ultralytics.com/bilibili"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-bilibili.png" width="3%" alt="Ultralytics BiliBili"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://discord.com/invite/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-discord.png" width="3%" alt="Ultralytics Discord"></a>
</div>
Raw data
{
"_id": null,
"home_page": null,
"name": "ultralytics-actions",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Ultralytics <hello@ultralytics.com>",
"keywords": "github-actions, ci-cd, workflow-automation, pull-request-automation, code-review, release-automation, markdown-processing, devops, github-integration, continuous-integration",
"author": null,
"author_email": "Glenn Jocher <glenn.jocher@ultralytics.com>",
"download_url": "https://files.pythonhosted.org/packages/77/79/402dea7339b9a57253685861b048712d010ea602daf1e2136ae224e5a305/ultralytics_actions-0.0.17.tar.gz",
"platform": null,
"description": "<a href=\"https://www.ultralytics.com/\" target=\"_blank\"><img src=\"https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg\" width=\"320\" alt=\"Ultralytics logo\"></a>\n\n# \ud83d\ude80 Ultralytics Actions: Auto-Formatting for Python, Markdown, and Swift\n\nWelcome to the [Ultralytics Actions](https://github.com/ultralytics/actions) repository, your go-to solution for maintaining consistent code quality across Ultralytics Python and Swift projects. This GitHub Action is designed to automate the formatting of Python, Markdown, and Swift files, ensuring adherence to our coding standards.\n\n[](https://github.com/marketplace/actions/ultralytics-actions) [](https://github.com/ultralytics/actions/actions/workflows/format.yml) <a href=\"https://discord.com/invite/ultralytics\"><img alt=\"Discord\" src=\"https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue\"></a> <a href=\"https://community.ultralytics.com/\"><img alt=\"Ultralytics Forums\" src=\"https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue\"></a> <a href=\"https://reddit.com/r/ultralytics\"><img alt=\"Ultralytics Reddit\" src=\"https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue\"></a>\n\n[](https://badge.fury.io/py/ultralytics-actions) [](https://pepy.tech/project/ultralytics-actions)\n\n## \ud83d\udcc4 Actions Description\n\nUltralytics Actions automatically applies formats, updates, and enhancements:\n\n- **Python Code:** Using [Ruff](https://github.com/astral-sh/ruff), a fast Python auto-formatter.\n- **Markdown Files:** With [Prettier](https://github.com/prettier/prettier), ensuring a consistent style in documentation.\n- **Docstrings:** Utilizing [docformatter](https://github.com/PyCQA/docformatter) for clean and standardized documentation comments.\n- **Swift Code:** Formatting Swift files using `swift-format` to ensure consistent coding style across Swift projects. _(Requires `macos-latest` to run correctly.)_\n- **Spell Check:** Employing [codespell](https://github.com/codespell-project/codespell) for catching common misspellings.\n- **Broken Links Check:** Implementing [Lychee](https://github.com/lycheeverse/lychee) to report broken links in docs and markdown files.\n- **PR Summary:** Generating concise [OpenAI](https://openai.com/) GPT4o-powered PR summaries, enhancing PR clarity.\n- **Auto-labeling:** Applying relevant labels to issues and pull requests using [OpenAI](https://openai.com/) GPT-4o for intelligent categorization.\n\n## \ud83d\udee0 How It Works\n\nUltralytics Actions triggers on various GitHub events:\n\n- **Push Events:** Automatically formats code when changes are pushed to the `main` branch.\n- **Pull Requests:**\n - Ensures that contributions meet our formatting standards before merging.\n - Generates a concise summary of the changes using GPT-4o.\n - Automatically applies relevant labels using GPT-4o for intelligent categorization.\n- **Issues:** Automatically applies relevant labels using GPT-4o when new issues are created.\n\nThese actions help maintain code quality, improve documentation clarity, and streamline the review process by providing consistent formatting, informative summaries, and appropriate categorization of issues and pull requests.\n\n## \ud83d\udd27 Setting Up the Action\n\nTo use this action in your Ultralytics repository:\n\n1. **Create a Workflow File:** In your repository, create a file under `.github/workflows/`, e.g., `ultralytics-actions.yml`.\n\n2. **Add the Action:** Use the Ultralytics Actions in your workflow file as follows:\n\n ```yaml\n name: Ultralytics Actions\n\n on:\n issues:\n types: [opened]\n pull_request:\n branches: [main]\n types: [opened, closed]\n\n jobs:\n format:\n runs-on: ubuntu-latest\n steps:\n - name: Run Ultralytics Formatting\n uses: ultralytics/actions@main\n with:\n token: ${{ secrets.GITHUB_TOKEN }} # automatically generated, do not modify\n labels: true # autolabel issues and PRs\n python: true # format Python code and docstrings\n prettier: true # format YAML, JSON, Markdown and CSS\n swift: true # format Swift code (requires 'macos-latest')\n spelling: true # check spelling\n links: true # check broken links\n summary: true # print PR summary with GPT4o (requires 'openai_api_key')\n openai_api_key: # your OpenAI API key\n ```\n\n3. **Customize:** Adjust the workflow settings as necessary for your project.\n\n## \ud83d\udca1 Contribute\n\nUltralytics thrives on community collaboration; we immensely value your involvement! We urge you to peruse our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for detailed insights on how you can participate. Don't forget to share your feedback with us by contributing to our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A heartfelt thank you \ud83d\ude4f goes out to everyone who has already contributed!\n\n<a href=\"https://github.com/ultralytics/yolov5/graphs/contributors\">\n<img width=\"100%\" src=\"https://github.com/ultralytics/assets/raw/main/im/image-contributors.png\" alt=\"Ultralytics open-source contributors\"></a>\n\n## \ud83d\udcc4 License\n\nUltralytics presents two distinct licensing paths to accommodate a variety of scenarios:\n\n- **AGPL-3.0 License**: This official [OSI-approved](https://opensource.org/license) open-source license is perfectly aligned with the goals of students, enthusiasts, and researchers who believe in the virtues of open collaboration and shared wisdom. Details are available in the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) document.\n- **Enterprise License**: Tailored for commercial deployment, this license authorizes the unfettered integration of Ultralytics software and AI models within commercial goods and services, without the copyleft stipulations of AGPL-3.0. Should your use case demand an enterprise solution, direct your inquiries to [Ultralytics Licensing](https://www.ultralytics.com/license).\n\n## \ud83d\udcee Contact\n\nFor bugs or feature suggestions pertaining to Ultralytics, please lodge an issue via [GitHub Issues](https://github.com/ultralytics/pre-commit/issues). You're also invited to participate in our [Discord](https://discord.com/invite/ultralytics) community to engage in discussions and seek advice!\n\n<br>\n<div align=\"center\">\n <a href=\"https://github.com/ultralytics\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png\" width=\"3%\" alt=\"Ultralytics GitHub\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://www.linkedin.com/company/ultralytics/\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png\" width=\"3%\" alt=\"Ultralytics LinkedIn\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://twitter.com/ultralytics\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png\" width=\"3%\" alt=\"Ultralytics Twitter\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://youtube.com/ultralytics?sub_confirmation=1\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png\" width=\"3%\" alt=\"Ultralytics YouTube\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://www.tiktok.com/@ultralytics\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png\" width=\"3%\" alt=\"Ultralytics TikTok\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://ultralytics.com/bilibili\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-bilibili.png\" width=\"3%\" alt=\"Ultralytics BiliBili\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://discord.com/invite/ultralytics\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-discord.png\" width=\"3%\" alt=\"Ultralytics Discord\"></a>\n</div>\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Ultralytics Actions for GitHub automation and PR management.",
"version": "0.0.17",
"project_urls": {
"Bug Reports": "https://github.com/ultralytics/actions/issues",
"Changelog": "https://github.com/ultralytics/actions/releases",
"Documentation": "https://docs.ultralytics.com",
"Homepage": "https://ultralytics.com",
"Source": "https://github.com/ultralytics/actions"
},
"split_keywords": [
"github-actions",
" ci-cd",
" workflow-automation",
" pull-request-automation",
" code-review",
" release-automation",
" markdown-processing",
" devops",
" github-integration",
" continuous-integration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bdb611b37e209825193150fd64b2169fc44c682fd9bc035c4f8c4e511ea3e832",
"md5": "842c8f547d2711bc885c4a68fc1009e7",
"sha256": "fc3ee12fdaa9b431728bdcda83ec5277ad6b37153146e4d6f447060dff0adda8"
},
"downloads": -1,
"filename": "ultralytics_actions-0.0.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "842c8f547d2711bc885c4a68fc1009e7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 35804,
"upload_time": "2024-10-29T21:06:04",
"upload_time_iso_8601": "2024-10-29T21:06:04.392072Z",
"url": "https://files.pythonhosted.org/packages/bd/b6/11b37e209825193150fd64b2169fc44c682fd9bc035c4f8c4e511ea3e832/ultralytics_actions-0.0.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7779402dea7339b9a57253685861b048712d010ea602daf1e2136ae224e5a305",
"md5": "001313bfeaac09eda027dc66b5918fa8",
"sha256": "39e3fbf1f499775fca225e9f45fa8428f39ca64a8f3c03a2c0be89450be6301b"
},
"downloads": -1,
"filename": "ultralytics_actions-0.0.17.tar.gz",
"has_sig": false,
"md5_digest": "001313bfeaac09eda027dc66b5918fa8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 35014,
"upload_time": "2024-10-29T21:06:06",
"upload_time_iso_8601": "2024-10-29T21:06:06.003813Z",
"url": "https://files.pythonhosted.org/packages/77/79/402dea7339b9a57253685861b048712d010ea602daf1e2136ae224e5a305/ultralytics_actions-0.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 21:06:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ultralytics",
"github_project": "actions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ultralytics-actions"
}
JSON
