ultralytics/actions
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update format.yml (#434)

Browse Source 
Signed-off-by: Glenn Jocher <[email protected]>
Co-authored-by: UltralyticsAssistant <[email protected]>
This commit is contained in:
Glenn Jocher
2025-05-07 01:06:18 +02:00
committed by GitHub
co-authored by UltralyticsAssistant
parent 6e7ab9726a
commit 2b6c352e64
2 changed files with 41 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/format.yml
+18 -12
View File
@@ -1,7 +1,7 @@
# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
# Ultralytics Actions https://github.com/ultralytics/actions
# This workflow automatically formats code and documentation in PRs to official Ultralytics standards
# This workflow formats code and documentation in PRs to Ultralytics standards
name: Ultralytics Actions
@@ -12,19 +12,25 @@ on:
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
jobs:
format:
actions:
runs-on: ubuntu-latest
steps:
- name: Run Ultralytics Formatting
- name: Run Ultralytics Actions
uses: ultralytics/actions@main
with:
token: ${{ secrets._GITHUB_TOKEN || secrets.GITHUB_TOKEN }} # note GITHUB_TOKEN automatically generated
labels: true # autolabel issues and PRs
python: true # format Python code and docstrings
prettier: true # format YAML, JSON, Markdown and CSS
spelling: false # check spelling
links: false # check broken links
summary: true # print PR summary (requires 'openai_api_key')
openai_api_key: ${{ secrets.OPENAI_API_KEY }}
brave_api_key: ${{ secrets.BRAVE_API_KEY }}
token: ${{ secrets._GITHUB_TOKEN || secrets.GITHUB_TOKEN }} # Auto-generated token
labels: true # Auto-label issues/PRs using AI
python: true # Format Python with Ruff and docformatter
prettier: true # Format YAML, JSON, Markdown, CSS
swift: false # Format Swift (requires macos-latest)
spelling: true # Check spelling with codespell
links: true # Check broken links with Lychee
summary: true # Generate AI-powered PR summaries
openai_api_key: ${{ secrets.OPENAI_API_KEY }} # Powers PR summaries, labels and comments
brave_api_key: ${{ secrets.BRAVE_API_KEY }} # Used for broken link resolution
README.md
+23 -12
View File
@@ -47,6 +47,11 @@ To integrate this action into your Ultralytics repository:
2. **Add the Action:** Configure the Ultralytics Actions in your workflow file as shown below:
```yaml
# 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:
@@ -54,24 +59,30 @@ To integrate this action into your Ultralytics repository:
types: [opened]
pull_request:
branches: [main]
types: [opened, closed]
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
jobs:
format:
runs-on: ubuntu-latest # Use 'macos-latest' if 'swift: true'
actions:
runs-on: ubuntu-latest
steps:
- name: Run Ultralytics Formatting
- name: Run Ultralytics Actions
uses: ultralytics/actions@main
with:
token: ${{ secrets.GITHUB_TOKEN }} # Automatically generated, do not modify
labels: true # Autolabel issues and PRs (requires 'openai_api_key')
python: true # Format Python code and docstrings with Ruff and docformatter
prettier: true # Format YAML, JSON, Markdown, and CSS with Prettier
swift: false # Format Swift code with swift-format (requires 'runs-on: macos-latest')
token: ${{ secrets.GITHUB_TOKEN }} # Auto-generated token
labels: true # Auto-label issues/PRs using AI
python: true # Format Python with Ruff and docformatter
prettier: true # Format YAML, JSON, Markdown, CSS
swift: false # Format Swift (requires macos-latest)
spelling: true # Check spelling with codespell
links: true # Check for broken links with Lychee
summary: true # Generate PR summary (requires 'openai_api_key')
openai_api_key: ${{ secrets.OPENAI_API_KEY }} # Add your OpenAI API key as a repository secret
links: true # Check broken links with Lychee
summary: true # Generate AI-powered PR summaries
openai_api_key: ${{ secrets.OPENAI_API_KEY }} # Powers PR summaries, labels and comments
brave_api_key: ${{ secrets.BRAVE_API_KEY }} # Used for broken link resolution
```
3. **Customize:** Adjust the `runs-on` runner and the boolean flags (`labels`, `python`, `prettier`, `swift`, `spelling`, `links`, `summary`) based on your project's needs. Remember to add your `OPENAI_API_KEY` as a secret in your repository settings if you enable `labels` or `summary`.