Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peter-evans/autopep8
A GitHub action for autopep8, a tool that automatically formats Python code to conform to the PEP 8 style guide.
https://github.com/peter-evans/autopep8
autopep8 formatter github-action pep8 python
Last synced: 24 days ago
JSON representation
A GitHub action for autopep8, a tool that automatically formats Python code to conform to the PEP 8 style guide.
- Host: GitHub
- URL: https://github.com/peter-evans/autopep8
- Owner: peter-evans
- License: mit
- Created: 2019-07-17T12:48:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-17T05:51:39.000Z (over 1 year ago)
- Last Synced: 2024-05-03T02:29:09.555Z (about 1 month ago)
- Topics: autopep8, formatter, github-action, pep8, python
- Language: Python
- Size: 337 KB
- Stars: 84
- Watchers: 3
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Lists
- awesome-workflows - autopep8: Automatically formats Python code to conform to the PEP 8 style guide
- awesome-actions - autopep8: Automatically formats Python code to conform to the PEP 8 style guide
- awesome-actions - autopep8: Automatically formats Python code to conform to the PEP 8 style guide
- awesome - autopep8: Automatically formats Python code to conform to the PEP 8 style guide
- fucking-awesome-actions - autopep8: Automatically formats Python code to conform to the PEP 8 style guide
- awesome-actions-fork - autopep8: Automatically formats Python code to conform to the PEP 8 style guide
- awesome-actions - autopep8: Automatically formats Python code to conform to the PEP 8 style guide
- awesome-actions - autopep8: Automatically formats Python code to conform to the PEP 8 style guide
- awesome-actions - autopep8: Automatically formats Python code to conform to the PEP 8 style guide
- awesome-actions - autopep8: Automatically formats Python code to conform to the PEP 8 style guide
- awesome-stars - autopep8 - evans | 84 | (Python)
README
# autopep8
[](https://github.com/marketplace/actions/autopep8)
A GitHub action for [autopep8](https://github.com/hhatto/autopep8), a tool that automatically formats Python code to conform to the PEP 8 style guide.
This action is designed to be used in conjunction with [Create Pull Request](https://github.com/peter-evans/create-pull-request). This will automatically create a pull request to merge fixes that autopep8 makes to python code in your repository.
## Usage
This action is a simple wrapper around [autopep8](https://github.com/hhatto/autopep8). Arguments should be passed to the action via the `args` parameter.
This example fixes all python files in your repository with aggressive level 2.
```yml
- name: autopep8
id: autopep8
uses: peter-evans/autopep8@v2
with:
args: --recursive --in-place --aggressive --aggressive .
```
The action outputs the exit code from autopep8. This can be useful in combination with the autopep8 flag `--exit-code` for pull request checks.
```yml
- name: Fail if autopep8 made changes
if: steps.autopep8.outputs.exit-code == 2
run: exit 1
```
See [autopep8 documentation](https://github.com/hhatto/autopep8) for further argument details.
## Automated pull requests
On its own this action is not very useful. Please use it in conjunction with [Create Pull Request](https://github.com/peter-evans/create-pull-request) or a [direct push to branch workflow](#direct-push-with-on-pull_request-workflows).
The following workflow is a simple example to demonstrate how the two actions work together.
```yml
name: Format python code
on: push
jobs:
autopep8:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: autopep8
uses: peter-evans/autopep8@v2
with:
args: --recursive --in-place --aggressive --aggressive .
- name: Create Pull Request
uses: peter-evans/create-pull-request@v3
with:
commit-message: autopep8 action fixes
title: Fixes by autopep8 action
body: This is an auto-generated PR with fixes by autopep8.
labels: autopep8, automated pr
reviewers: peter-evans
branch: autopep8-patches
```
This configuration will create pull requests that look like this:
## Automated pull requests with "on: pull_request" workflows
**Update**: While the following approach does work in some cases, my strong recommendation would be to use a slash command style "ChatOps" solution for operations on pull requests. See [slash-command-dispatch](https://github.com/peter-evans/slash-command-dispatch) for such a solution.
The following is an example workflow for a use-case where autopep8 runs as both a check on pull requests and raises a further pull request to apply fixes.
How it works:
1. When a pull request is raised the workflow executes as a check.
2. If autopep8 makes any fixes a pull request will be raised for those fixes to be merged into the current pull request branch. The workflow then deliberately causes the check to fail.
3. When the pull request containing the fixes is merged the workflow runs again. This time autopep8 makes no changes and the check passes.
4. The original pull request can now be merged.
Note that due to [token restrictions on public repository forks](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token), this workflow does not work for pull requests raised from forks.
Private repositories can be configured to [enable workflows](https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) from forks to run without restriction.
```yml
name: autopep8
on: pull_request
jobs:
autopep8:
# Check if the PR is not raised by this workflow and is not from a fork
if: startsWith(github.head_ref, 'autopep8-patches') == false && github.event.pull_request.head.repo.full_name == github.repository
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
- name: autopep8
id: autopep8
uses: peter-evans/autopep8@v2
with:
args: --exit-code --recursive --in-place --aggressive --aggressive .
- name: Set autopep8 branch name
id: vars
run: |
branch-name="autopep8-patches/${{ github.head_ref }}"
echo "branch-name=$branch-name" >> $GITHUB_OUTPUT
- name: Create Pull Request
if: steps.autopep8.outputs.exit-code == 2
uses: peter-evans/create-pull-request@v3
with:
commit-message: autopep8 action fixes
title: Fixes by autopep8 action
body: This is an auto-generated PR with fixes by autopep8.
labels: autopep8, automated pr
reviewers: peter-evans
branch: ${{ steps.vars.outputs.branch-name }}
- name: Fail if autopep8 made changes
if: steps.autopep8.outputs.exit-code == 2
run: exit 1
```
## Direct push with "on: pull_request" workflows
The following workflow is an alternative to the previous workflow. Instead of raising a second pull request it commits the changes made by autopep8 directly to the pull request branch.
**Important caveat:** If you have other pull request checks besides the following workflow then you must use a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) instead of the default `GITHUB_TOKEN`.
This is due to a deliberate limitation imposed by GitHub Actions that events raised by a workflow (such as `push`) cannot trigger further workflow runs.
This is to prevent accidental "infinite loop" situations, and as an anti-abuse measure.
Using a `repo` scoped [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is an approved workaround. See [here](https://github.com/peter-evans/create-pull-request/blob/master/docs/concepts-guidelines.md#triggering-further-workflow-runs) for further detail.
How it works:
1. When a pull request is raised the workflow executes as a check.
2. If autopep8 makes any fixes they will be committed directly to the current pull request branch.
3. The `push` triggers all pull request checks to run again.
Note that due to [token restrictions on public repository forks](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token), this workflow does not work for pull requests raised from forks.
Private repositories can be configured to [enable workflows](https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) from forks to run without restriction.
```yml
name: autopep8
on: pull_request
jobs:
autopep8:
# Check if the PR is not from a fork
if: github.event.pull_request.head.repo.full_name == github.repository
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
token: ${{ secrets.REPO_ACCESS_TOKEN }}
ref: ${{ github.head_ref }}
- name: autopep8
id: autopep8
uses: peter-evans/autopep8@v2
with:
args: --exit-code --recursive --in-place --aggressive --aggressive .
- name: Commit autopep8 changes
if: steps.autopep8.outputs.exit-code == 2
run: |
git config --global user.name 'Peter Evans'
git config --global user.email '[email protected]'
git commit -am "Automated autopep8 fixes"
git push
```
## License
MIT License - see the [LICENSE](LICENSE) file for details