name: Black Code Format Check

on:
  pull_request:
    branches: [ main, develop ]
    paths:
      - '**.py'

permissions:
  contents: read
  pull-requests: write

jobs:
  black:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: your-username/black-action@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          python-version: '3.x'        # optional, default is '3.x'
          black-version: '23.12.0'     # optional, default is '23.12.0'
          black-args: '--check --verbose'  # optional, default is '--check --verbose'
          paths: 'src tests'           # optional, default is '.'
          fail-on-error: 'true'        # optional, default is 'true'
          comment-mode: 'replace'      # optional, default is 'replace'

- uses: your-username/black-action@v1
  with:
    paths: 'src tests scripts'

- uses: your-username/black-action@v1
  with:
    fail-on-error: 'false'

# Replace existing comments (default)
- uses: your-username/black-action@v1
  with:
    comment-mode: 'replace'

# Append new comments
- uses: your-username/black-action@v1
  with:
    comment-mode: 'append'

# No comments
- uses: your-username/black-action@v1
  with:
    comment-mode: 'none'