mirror of
https://github.com/creyD/autopep8_action.git
synced 2026-04-12 19:40:28 +02:00
df480820245a485234b97e84594629122fbf1ce9
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 | ❌ | 'false' | Path for the repositories 'requirements.txt'. If you have none, you may skip this. |
| branch | ✅ | - | The specific branch you want to merge into. Use ${{ github.head_ref }} if you want to use this with pull requests. |
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
Languages
Shell
87.2%
Dockerfile
12.8%