creyD/autoflake_action
1
0
Fork 0
mirror of https://github.com/creyD/autoflake_action.git synced 2026-04-12 19:40:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Using default GITHUB_TOKEN now

Browse Source
This commit is contained in:
Conrad
2023-05-23 13:30:38 +02:00
parent 22a4101d15
commit 55de1ca890
2 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -1,5 +1,10 @@
# GitHub autoflake Action # GitHub autoflake Action
[![License MIT](https://img.shields.io/github/license/creyD/autoflake_action)](https://github.com/creyD/autoflake_action/blob/master/LICENSE)
[![Latest Release](https://img.shields.io/github/v/release/creyD/autoflake_action)](https://github.com/creyD/autoflake_action/releases)
[![Contributors](https://img.shields.io/github/contributors-anon/creyD/autoflake_action)](https://github.com/creyD/autoflake_action/graphs/contributors)
[![Issues](https://img.shields.io/github/issues/creyD/autoflake_action)](https://github.com/creyD/autoflake_action/issues)
This GitHub action automatically removes unused imports and variables from your Python code using [autoflake](https://pypi.org/project/autoflake/). This GitHub action automatically removes unused imports and variables from your Python code using [autoflake](https://pypi.org/project/autoflake/).
## Usage ## Usage
@@ -15,15 +20,14 @@ The following parameters can be used in your custom action configuration.
| no_commit | :x: | False | Avoid committing, if used in a pipeline | | no_commit | :x: | False | Avoid committing, if used in a pipeline |
| options | :x: | ' ' | Parameters to use with autoflake | | 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. | | dry | :x: | false | Dry-run the action to fail when detecting uncompliant files, instead of automatically fixing them. |
| github_token | :x: | `${{ github.token }}` | The default [GITHUB_TOKEN](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret) or a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)
### Example ### Example
This is a simple usage example of this script: This is a simple usage example of this script:
```yaml ```yaml
# This action works with pull requests and pushes name: autoflake format
name: Continuous Integration
on: on:
pull_request: pull_request:
@@ -37,9 +41,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: creyD/autoflake_action@master - uses: creyD/autoflake_action@v1.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```

4
action.yml
View File

@@ -31,6 +31,10 @@ inputs:
description: Can be used to avoid committing the changes description: Can be used to avoid committing the changes
required: false required: false
default: false default: false
github_token:
description: GitHub Token or PAT token used to authenticate against a repository
required: false
default: ${{ github.token }}
runs: runs:
using: 'docker' using: 'docker'