black.yml

# This is a workflow to format Python code with black formatter

name: black

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
  pull_request:
  push:
    branches: [main]

permissions: read-all

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "black"
  black:
    # The type of runner that the job will run on
    runs-on: ubuntu-20.04

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v4
      # Set up a Python environment for use in actions
      - uses: actions/setup-python@v5

      # Run black code formatter
      - uses: psf/black@stable
        with:
          args: ". --check"
          version: "24.1.1"