mirror of
https://github.com/creyD/autopep8_action.git
synced 2026-04-14 12:20:32 +02:00
57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
# GitHub autopep8 Action
|
|
|
|
This action uses the newly released GitHub action to automatically restyle your Python code according to [PEP-8](https://www.python.org/dev/peps/pep-0008/) using [autopep8](https://github.com/hhatto/autopep8).
|
|
|
|
## Usage
|
|
### Parameters
|
|
The following parameters can be used in your custom action configuration.
|
|
|
|
| Parameter | Required | Default | Description |
|
|
| - | - | - | - |
|
|
| commit_message | :x: | 'Adjusted files for PEP-8 compliance' | Custom git commit message|
|
|
| commit_options | :x: | - | Custom git commit options|
|
|
| file_pattern | :x: | '*' | Custom file pattern for `git add`|
|
|
| dependencies | :x: | 'requirements.txt' | Path for the repositories 'requirements.txt'. If you have none, you may skip this.|
|
|
| checkpath | :x: | '.' | The path autopep8 checks |
|
|
| options | :x: | ' ' | Parameters to use with autopep8 |
|
|
| dry | :x: | 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:
|
|
|
|
```yaml
|
|
# 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](https://github.com/creyD/autopep8_action/issues/new).
|
|
|
|
## Special Thanks
|
|
|
|
- Hideo Hattori [(GitHub)](https://github.com/hhatto) for creating and maintaining autopep8
|
|
- Stefan Zweifel [(GitHub)](https://github.com/stefanzweifel) for providing an action to commit and push a git change
|