mirror of
https://github.com/creyD/autoflake_action.git
synced 2026-04-13 20:10:30 +02:00
49 lines
1.4 KiB
Markdown
49 lines
1.4 KiB
Markdown
# GitHub autoflake Action
|
|
|
|
This GitHub action automatically removes unused imports and variables from your Python code using [autoflake](https://pypi.org/project/autoflake/).
|
|
|
|
## Usage
|
|
### Parameters
|
|
The following parameters can be used in your custom action configuration.
|
|
|
|
| Parameter | Required | Default | Description |
|
|
| - | - | - | - |
|
|
| commit_message | :x: | 'Removed unused imports and variables' | Custom git commit message |
|
|
| commit_options | :x: | - | Custom git commit options |
|
|
| file_pattern | :x: | '*' | Custom file pattern for `git add` |
|
|
| checkpath | :x: | '.' | The path autoflake checks |
|
|
| no_commit | :x: | False | Avoid committing, if used in a pipeline |
|
|
| options | :x: | ' ' | Parameters to use with autoflake |
|
|
| dry | :x: | false | Dry-run the action to fail when detecting 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@v3
|
|
- uses: creyD/action_autoflake@master
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
```
|
|
|
|
## Issues
|
|
|
|
Please report all bugs and feature request using the [GitHub issues function](https://github.com/creyD/autoflake_action/issues/new).
|