Merge pull request #32 from J-Fields/exclude-deleted-files

Exclude deleted files when using `only_changed`

Dockerfile

@@ -1,4 +1,4 @@
 FROM node:lts-alpine3.9
-RUN apk update && apk upgrade && apk add --no-cache bash git openssh
+RUN apk update && apk add --no-cache bash git openssh
 COPY entrypoint.sh /entrypoint.sh
 ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -16,16 +16,21 @@ A GitHub action for styling files with [prettier](https://prettier.io).
 
 | Parameter | Required | Default | Description |
 | - | :-: | :-: | - |
-| dry | :x: | False | Runs the action in dry mode. Files wont get changed and the action fails if there are unprettified files. |
-| prettier_version | :x: | False | Specific prettier version (by default use latest) |
-| prettier_options | :x: | `--write **/*.js` | Prettier options (by default it applies to the whole repository) |
+| dry | :x: | `false` | Runs the action in dry mode. Files wont get changed and the action fails if there are unprettified files. |
+| prettier_version | :x: | `false` | Specific prettier version (by default use latest) |
+| prettier_options | :x: | `"--write **/*.js"` | Prettier options (by default it applies to the whole repository) |
 | commit_options | :x: | - | Custom git commit options |
-| commit_message | :x: | Prettified Code! | Custom git commit message |
-| file_pattern | :x: | * | Custom git add file pattern |
-| branch (depreciated with 3.0)| :white_check_mark: | - | Always set this to `${{ github.head_ref }}` in order to work both with pull requests and push events |
+| same_commit | :x: | `false` | Update the current commit instead of creating a new one, created by [Joren Broekema](https://github.com/jorenbroekema), this command works only with the checkout action set to fetch depth '0' (see example 2)  |
+| commit_message | :x: | `"Prettified Code!"` | Custom git commit message, will be ignored if used with `same_commit` |
+| file_pattern | :x: | `*` | Custom git add file pattern, can't be used with only_changed! |
+| branch (deprecated with 3.0)| :white_check_mark: | - | Always set this to `${{ github.head_ref }}` in order to work both with pull requests and push events |
+| only_changed | :x: | `false` | Only prettify changed files, can't be used with file_pattern! This command works only with the checkout action set to fetch depth '0' (see example 2)|
+
+> 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 Config
 
+#### Example 1 (run on push in master)
 ```yaml
 name: Continuous Integration
 
@@ -48,10 +53,43 @@ jobs:
         ref: ${{ github.head_ref }}
 
     - name: Prettify code
-      uses: creyD/prettier_action@v2.2
+      uses: creyD/prettier_action@v3.1
       with:
         # This part is also where you can pass other options, for example:
         prettier_options: --write **/*.{js,md}
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+#### Example 2 (using the only_changed or same_commit option on PR)
+```yaml
+name: Continuous Integration
+
+on:
+  pull_request:
+    branches: [master]
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        # Make sure the actual branch is checked out when running on pull requests
+        ref: ${{ github.head_ref }}
+        # This is important to fetch the changes to the previous commit
+        fetch-depth: 0
+
+    - name: Prettify code
+      uses: creyD/prettier_action@v3.1
+      with:
+        # This part is also where you can pass other options, for example:
+        prettier_options: --write **/*.{js,md}
+        only_changed: True
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 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).

action.yml

@@ -5,14 +5,18 @@ author: Conrad Großer <grosserconrad@gmail.com>
 
 inputs:
   commit_message:
-    description: Commit message
+    description: Commit message, will be ignored if used with same_commit
     required: false
     default: 'Prettified Code!'
+  same_commit:
+    description: Update the current commit instead of creating a new one
+    required: false
+    default: false
   commit_options:
     description: Commit options
     required: false
   file_pattern:
-    description: File pattern used for `git add`
+    description: File pattern used for `git add`, can't be used with only_changed!
     required: false
     default: '*'
   prettier_options:
@@ -27,6 +31,10 @@ inputs:
     description: Specific version of prettier (by default just use the latest version)
     required: false
     default: false
+  only_changed:
+    description: Only prettify files changed in the last commit, can't be used with file_pattern!
+    required: false
+    default: false
 
 runs:
   using: 'docker'

entrypoint.sh

@@ -41,20 +41,35 @@ echo "Files:"
 prettier $INPUT_PRETTIER_OPTIONS || echo "Problem running prettier with $INPUT_PRETTIER_OPTIONS"
 
 # To keep runtime good, just continue if something was changed
-if _git_changed;
-then
+if _git_changed; then
   if $INPUT_DRY; then
     echo "Prettier found unpretty files!"
     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}"
+
+    if $INPUT_ONLY_CHANGED; then
+      # --diff-filter=d excludes deleted files
+      for file in $(git diff --name-only --diff-filter=d HEAD^..HEAD)
+      do
+        git add $file
+      done
+    else
+      # Add changes to git
+      git add "${INPUT_FILE_PATTERN}" || echo "Problem adding your files with pattern ${INPUT_FILE_PATTERN}"
+    fi
+
     # 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
+    if $INPUT_SAME_COMMIT; then
+      echo "Amending the current commit..."
+      git pull
+      git commit --amend --no-edit
+      git push origin -f
+    else
+      git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"} || echo "No files added to commit"
+      git push origin
+    fi
     echo "Changes pushed successfully."
   fi
 else