From 191697834dd38451adeb03e9736d95a97ef0f30b Mon Sep 17 00:00:00 2001 From: Conrad Date: Wed, 24 May 2023 10:45:37 +0200 Subject: [PATCH] Minor Cleanup --- .gitignore | 2 ++ README.md | 4 ++++ entrypoint.sh | 13 ++++++++++++- 3 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..166a4ec --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# MacOS system files +.DS_Store diff --git a/README.md b/README.md index 19c2b52..e619d89 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,8 @@ The following parameters can be used in your custom action configuration. | 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: @@ -49,6 +51,8 @@ jobs: - 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/autopep8_action/issues/new). diff --git a/entrypoint.sh b/entrypoint.sh index c710a29..7d34e40 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -2,6 +2,7 @@ # 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) @@ -25,6 +26,14 @@ _git_changed() { [[ -n "$(git status -s)" ]] } +_git_changes() { + git diff +} + +# PROGRAM +# Changing to the directory +cd "$GITHUB_ACTION_PATH" + echo "Running autopep8..." autopep8 -i -r $INPUT_CHECKPATH $INPUT_OPTIONS || echo "Problem running autopep8!" @@ -35,7 +44,9 @@ fi if _git_changed; then if $INPUT_DRY; then - echo "Found non-compliant files!" + echo "Found non-compliant files:" + _git_changes + echo "Finishing dry-run. Exiting before committing." exit 1 else # Calling method to configure the git environemnt