2022-01-04 16:06:43 +01:00
2022-01-04 16:06:43 +01:00
2022-01-04 16:06:43 +01:00
2019-11-14 23:53:00 +01:00
2022-01-04 16:06:43 +01:00

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
checkpath '.' The path autopep8 checks
no_commit False Avoid committing, if used in a pipeline
options ' ' 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:

# This action works with pull requests and pushes
name: Continuous Integration

on:
  pull_request:
  push:
    branches:
    - master

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
      with:
        # Make sure the actual branch is checked out when running on pull requests
        ref: ${{ github.head_ref }}
    - uses: creyD/action_autopep8@master
      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
Description
Automatically runs the autopep8 command against any commit/ pull request created.
Readme MIT 94 KiB
Languages
Shell 87.2%
Dockerfile 12.8%