autopep8_action/README.md

GitHub autopep8 Action

This action uses the newly released GitHub action to automatically restyle your Python code according to PEP-8 using autopep8.

Usage

Parameters

The following parameters can be used in your custom action configuration.

Parameter	Required	Default	Description
commit_message	❌	'Adjusted files for PEP-8 compliance'	Custom git commit message
commit_options	❌	-	Custom git commit options
file_pattern	❌	'*'	Custom file pattern for git add
dependencies	❌	'requirements.txt'	Path for the repositories 'requirements.txt'. If you have none, you may skip this.
checkpath	❌	'.'	The path autopep8 checks
autoparameters	❌	' '	Parameters to use with autopep8
dry	❌	false	Dry-run the action to fail when detecting PEP-8 uncompliant files, instead of automatically fixing them.

Example

This is a simple usage example of this script:

name: Autopep 8

on: [pull_request]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v1
      with:
        fetch-depth: 1
    - uses: creyD/action_autopep8@master
      with:
        dependencies: 'requirements.txt'
        branch: ${{ github.head_ref }}
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Issues

Please report all bugs and feature request using the GitHub issues function.

Special Thanks

• Hideo Hattori (GitHub) for creating and maintaining autopep8
• Stefan Zweifel (GitHub) for providing an action to commit and push a git change