Removed i and r default options from autopep

Feature Upgrade

.gitignore

@@ -0,0 +1,2 @@
+# MacOS system files
+.DS_Store

Dockerfile

@@ -1,3 +1,9 @@
-FROM python:3
+FROM python:3.11.3-slim-bullseye
+
+RUN apt update && apt install -y --no-install-recommends git
+
+RUN pip install --no-cache-dir -q --upgrade pip
+RUN pip install --no-cache-dir -q autopep8
+
 COPY entrypoint.sh /entrypoint.sh
 ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -1,52 +1,66 @@
 # 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).
+[![License MIT](https://img.shields.io/github/license/creyD/autopep8_action)](https://github.com/creyD/autopep8_action/blob/master/LICENSE)
+[![Latest Release](https://img.shields.io/github/v/release/creyD/autopep8_action)](https://github.com/creyD/autopep8_action/releases)
+[![Contributors](https://img.shields.io/github/contributors-anon/creyD/autopep8_action)](https://github.com/creyD/autopep8_action/graphs/contributors)
+[![Issues](https://img.shields.io/github/issues/creyD/autopep8_action)](https://github.com/creyD/autopep8_action/issues)
+
+This action automatically restyles 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.|
-| branch | :white_check_mark: | - | The specific branch you want to merge into. Use ${{ github.head_ref }} if you want to use this with pull requests. |
+| 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` |
 | checkpath | :x: | '.' | The path autopep8 checks |
-| autoparameters | :x: | - | Parameters to use with autopep8 |
+| no_commit | :x: | False | Avoid committing, if used in a pipeline |
+| 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. |
+| 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)
+
+> Note: using the same_commit option may lead to problems if other actions are relying on the commit being the same before and after the prettier action has ran. Keep this in mind.
 
 ### Example
 
 This is a simple usage example of this script:
 
-```
-name: Autopep 8
+```yaml
+# This action works with pull requests and pushes
+name: Continuous Integration
 
-on: [pull_request]
+on:
+  pull_request:
+  push:
+    branches:
+    - master
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
       with:
-        fetch-depth: 1
-    - uses: creyD/action_autopep8@master
-      with:
-        dependencies: 'requirements.txt'
-        branch: ${{ github.head_ref }}
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
+        # Make sure the actual branch is checked out when running on pull requests
+        ref: ${{ github.head_ref }}
+    - uses: creyD/action_autopep8@v3.1
 ```
 
+More documentation for writing a workflow can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).
+
 ## Issues
 
-Please report all bugs and feature request using the [GitHub issues function](https://github.com/creyD/action_autopep8/issues/new).
+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
+
+
+If you want you may also use my [autoflake](https://github.com/creyD/autoflake_action) and [prettier](https://github.com/creyD/prettier_action) GitHub actions.

action.yml

@@ -1,5 +1,5 @@
-name: 'Autopep8 Action'
-description: 'Automatically runs the autopep8 command against any commit/ pull request created.'
+name: Autopep8 Action
+description: Automatically runs the autopep8 command on all your changes.
 
 author: Conrad Großer <grosserconrad@gmail.com>
 
@@ -12,35 +12,33 @@ inputs:
     description: Commit options
     required: false
   file_pattern:
-    description: File pattern used for "git add"
+    description: File pattern used for `git add`
     required: false
     default: '*'
-  dependencies:
-    description: Path for the repositories 'requirements.txt'. If you have none, you may skip this.
-    required: false
-    default: 'requirements.txt'
-  branch:
-    description: Branch which the changes are merged to
-    required: true
   checkpath:
     description: Path autopep8 checks
     required: false
     default: '.'
-  autoparameters:
+  options:
     description: Parameters for autopep8
     required: false
+    default: ''
+  dry:
+    description: Should this script apply autopep8 directly or just warn?
+    required: false
+    default: false
+  no_commit:
+    description: Can be used to avoid committing the changes
+    required: false
+    default: false
+  github_token:
+    description: GitHub Token or PAT token used to authenticate against a repository
+    required: false
+    default: ${{ github.token }}
 
 runs:
   using: 'docker'
   image: 'Dockerfile'
-  args:
-    - ${{ inputs.commit_message }}
-    - ${{ inputs.commit_options }}
-    - ${{ inputs.file_pattern }}
-    - ${{ inputs.dependencies }}
-    - ${{ inputs.branch }}
-    - ${{ inputs.checkpath }}
-    - ${{ inputs.autoparameters }}
 
 branding:
   icon: 'fast-forward'

entrypoint.sh

@@ -1,47 +1,64 @@
-#!/bin/sh -l
-
+#!/bin/bash
+# e is for exiting the script automatically if a command fails, u is for exiting if a variable is not set
+# x would be for showing the commands before they are executed
 set -eu
+shopt -s globstar
 
+# FUNCTIONS
 # Function for setting up git env in the docker container (copied from https://github.com/stefanzweifel/git-auto-commit-action/blob/master/entrypoint.sh)
-git_setup ( ) {
-  cat <<- EOF > $HOME/.netrc
-        machine github.com
-        login $GITHUB_ACTOR
-        password $GITHUB_TOKEN
-        machine api.github.com
-        login $GITHUB_ACTOR
-        password $GITHUB_TOKEN
+_git_setup() {
+    cat <<- EOF > $HOME/.netrc
+      machine github.com
+      login $GITHUB_ACTOR
+      password $GITHUB_TOKEN
+      machine api.github.com
+      login $GITHUB_ACTOR
+      password $GITHUB_TOKEN
 EOF
     chmod 600 $HOME/.netrc
 
     git config --global user.email "actions@github.com"
-    git config --global user.name "GitHub Actions"
+    git config --global user.name "GitHub Action"
 }
 
-echo "Installing dependencies..."
-pip install -q --upgrade pip
-# Install dependencies
-pip install -q autopep8
+# Checks if any files are changed
+_git_changed() {
+    [[ -n "$(git status -s)" ]]
+}
 
-# Install custom project dependencies if applicable
-pip install -r $INPUT_DEPENDENCIES || echo "No dependency file found."
+_git_changes() {
+    git diff
+}
+
+# PROGRAM
+# Changing to the directory
+cd "$GITHUB_ACTION_PATH"
 
-# Apply PEP 8
 echo "Running autopep8..."
-autopep8 --in-place -r $INPUT_CHECKPATH ${INPUT_AUTOPARAMETERS:+"$INPUT_AUTOPARAMETERS"} || echo "Problem running autopep8."
+autopep8 $INPUT_CHECKPATH $INPUT_OPTIONS || echo "Problem running autopep8!"
 
-if ! git diff --quiet
+if $INPUT_NO_COMMIT; then
+  exit 0
+fi
+
+if _git_changed;
 then
-  echo "Commiting and pushing changes."
-  # Calling method to configure the git environemnt
-  git_setup
-  # Switch to the actual branch
-  git checkout $INPUT_BRANCH
-
-  git add "${INPUT_FILE_PATTERN}"
-
-  git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"}
-  git push --set-upstream origin "HEAD:$INPUT_BRANCH"
+  if $INPUT_DRY; then
+    echo "Found non-compliant files:"
+    _git_changes
+    echo "Finishing dry-run. Exiting before committing."
+    exit 1
+  else
+    # Calling method to configure the git environemnt
+    _git_setup
+    echo "Commiting and pushing changes..."
+    # Add changes to git
+    git add "${INPUT_FILE_PATTERN}" || echo "Problem adding your files with pattern ${INPUT_FILE_PATTERN}"
+    # Commit and push changes back
+    git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"}
+    git push origin
+    echo "Changes pushed successfully."
+  fi
 else
   echo "Nothing to commit. Exiting."
 fi