README.md

YAPF Python Code Formatting Check

A GitHub action that runs YAPF to test if your python code is correctly formatted.

Once Configured, your action workflow will succeed only if your code is formatted in YAPF style.

The action uses the --diff parameter of YAPF in order to return:

• SUCCESS: exit-code=zero → no changes were necessary, code is YAPF-formatted
• FAIL: exit-code=non-zero → not correctly formatted or program error

Usage

To use this action in your repository, create a file like .github/workflows/yapf_check.yml with the following content:

name: YAPF Formatting Check
on: [push]
jobs:
  formatting-check:
    name: Formatting Check
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: run YAPF to test if python code is correctly formatted
      uses: AlexanderMelde/yapf-action@master
      with:
        args: --verbose

You can pass any other YAPF parameter using the args setting, e.g. for setting a different code style (default is PEP8), but you can also remove the with section entirely if you wish.

If you want to exclude a certain directory, you can use the args field like this: args: --verbose --exclude '**/tests/**'. Thank you @pksol for the example.