From 5cea39febe4be1f917384e5810836e6cecfc186d Mon Sep 17 00:00:00 2001 From: Conrad Date: Fri, 16 Oct 2020 09:15:41 +0200 Subject: [PATCH 01/18] Added only_changed feature --- README.md | 7 ++++--- action.yml | 6 +++++- entrypoint.sh | 14 ++++++++++---- 3 files changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4941adc..5c70779 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,14 @@ 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) | +| 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 | +| file_pattern | :x: | * | Custom git add file pattern, can't be used with only_changed! | | 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 | +| only_changed | :x: | false | Only prettify changed files, can't be used with file_pattern! | ### Example Config diff --git a/action.yml b/action.yml index de6218f..684b0f6 100644 --- a/action.yml +++ b/action.yml @@ -12,7 +12,7 @@ inputs: 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 +27,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' diff --git a/entrypoint.sh b/entrypoint.sh index 91abb9c..4baa4db 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -41,8 +41,7 @@ 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 @@ -50,8 +49,15 @@ then # 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 + for file in $(git diff --name-only 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 From 824711396fd616fb7b395b28a3c12798637cfcc4 Mon Sep 17 00:00:00 2001 From: Conrad Date: Fri, 16 Oct 2020 09:32:45 +0200 Subject: [PATCH 02/18] Improved example code --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5c70779..d48d293 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,8 @@ jobs: with: # This part is also where you can pass other options, for example: prettier_options: --write **/*.{js,md} + 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). From 2950e4532b0e954dfd0a32148b039df7a198f3b1 Mon Sep 17 00:00:00 2001 From: Conrad Date: Fri, 16 Oct 2020 09:33:01 +0200 Subject: [PATCH 03/18] Added exception for empty commits --- entrypoint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index 4baa4db..08fb28e 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -59,7 +59,7 @@ if _git_changed; then 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 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 echo "Changes pushed successfully." fi From 00252f67324da745f7c4e48eb12592a47c9b060f Mon Sep 17 00:00:00 2001 From: Conrad Date: Fri, 16 Oct 2020 09:43:47 +0200 Subject: [PATCH 04/18] Added example for new only_changed option --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d48d293..61bb141 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,11 @@ A GitHub action for styling files with [prettier](https://prettier.io). | commit_message | :x: | Prettified Code! | Custom git commit message | | file_pattern | :x: | * | Custom git add file pattern, can't be used with only_changed! | | 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 | -| only_changed | :x: | false | Only prettify changed files, can't be used with file_pattern! | +| 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' (Example 2)| ### Example Config +#### Example 1 (run on push in master) ```yaml name: Continuous Integration @@ -49,7 +50,37 @@ jobs: ref: ${{ github.head_ref }} - name: Prettify code - uses: creyD/prettier_action@v2.2 + uses: creyD/prettier_action@v3.0 + 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 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.0 with: # This part is also where you can pass other options, for example: prettier_options: --write **/*.{js,md} From 6ad77586cdd758581f20358b9e36dfb21d7c4cc5 Mon Sep 17 00:00:00 2001 From: jorenbroekema Date: Fri, 16 Oct 2020 12:27:20 +0200 Subject: [PATCH 05/18] feat: allow action to use current commit instead of creating a new one --- README.md | 3 +++ action.yml | 4 ++++ entrypoint.sh | 7 ++++++- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4941adc..f9c7096 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,13 @@ A GitHub action for styling files with [prettier](https://prettier.io). | 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 | +| same_commit | :x: | False | Whether to merge into the current commit instead of creating a new one | | 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 | +> 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 ```yaml diff --git a/action.yml b/action.yml index de6218f..7c10880 100644 --- a/action.yml +++ b/action.yml @@ -8,6 +8,10 @@ inputs: description: Commit message required: false default: 'Prettified Code!' + same_commit: + description: Whether to use the current commit instead of creating a new one + required: false + default: false commit_options: description: Commit options required: false diff --git a/entrypoint.sh b/entrypoint.sh index 91abb9c..9650cc0 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -53,7 +53,12 @@ then # 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"} + if $INPUT_SAME_COMMIT; then + echo "Amending the current commit..." + git commit --amend --no-edit + else + git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"} + fi git push origin echo "Changes pushed successfully." fi From 3c71a9826d14351d69b9a0410dca08ff8e13e19a Mon Sep 17 00:00:00 2001 From: Conrad Date: Sat, 17 Oct 2020 14:25:22 +0200 Subject: [PATCH 06/18] Improved documentation of the new same_commit feature --- README.md | 4 ++-- action.yml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b17dcb0..a343fd3 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ A GitHub action for styling files with [prettier](https://prettier.io). | 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 | -| same_commit | :x: | False | Whether to merge into the current commit instead of creating a new one | -| commit_message | :x: | Prettified Code! | Custom git commit message | +| same_commit | :x: | False | Update the current commit instead of creating a new one, created by [Joren Broekema](https://github.com/jorenbroekema) | +| 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 (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 | | 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' (Example 2)| diff --git a/action.yml b/action.yml index 920f90c..1314f93 100644 --- a/action.yml +++ b/action.yml @@ -5,11 +5,11 @@ author: Conrad Großer 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: Whether to use the current commit instead of creating a new one + description: Update the current commit instead of creating a new one required: false default: false commit_options: From bb4a6369468e6a0e01dc8522fee7093f71c1886b Mon Sep 17 00:00:00 2001 From: Conrad Date: Sat, 17 Oct 2020 14:28:22 +0200 Subject: [PATCH 07/18] Attempt on bugfixing the new same_commit option --- entrypoint.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/entrypoint.sh b/entrypoint.sh index 9b2eb5e..d8d1b9a 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -61,6 +61,7 @@ if _git_changed; then # Commit and push changes back if $INPUT_SAME_COMMIT; then echo "Amending the current commit..." + git pull git commit --amend --no-edit 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" From 39ff9b668eaacd3af9769a7f2c5a95aef10a67cb Mon Sep 17 00:00:00 2001 From: Conrad Date: Sat, 17 Oct 2020 19:53:43 +0200 Subject: [PATCH 08/18] Revert "Attempt on bugfixing the new same_commit option" This reverts commit bb4a6369468e6a0e01dc8522fee7093f71c1886b. --- entrypoint.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index d8d1b9a..9b2eb5e 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -61,7 +61,6 @@ if _git_changed; then # Commit and push changes back if $INPUT_SAME_COMMIT; then echo "Amending the current commit..." - git pull git commit --amend --no-edit 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" From bf27e9d676e5544f2a4fe2acc0770354ac5461a4 Mon Sep 17 00:00:00 2001 From: Conrad Date: Sat, 17 Oct 2020 20:01:43 +0200 Subject: [PATCH 09/18] Moved git amend before git add --- entrypoint.sh | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/entrypoint.sh b/entrypoint.sh index 9b2eb5e..978cd61 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -48,21 +48,20 @@ if _git_changed; then else # Calling method to configure the git environemnt _git_setup - echo "Commiting and pushing changes..." - if $INPUT_ONLY_CHANGED; then - for file in $(git diff --name-only 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 if $INPUT_SAME_COMMIT; then echo "Amending the current commit..." - git commit --amend --no-edit + git commit --amend else + if $INPUT_ONLY_CHANGED; then + for file in $(git diff --name-only 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 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" fi git push origin From 6024a801dafaefb261b7481170664676dd0ae07c Mon Sep 17 00:00:00 2001 From: Conrad Date: Sat, 17 Oct 2020 20:05:03 +0200 Subject: [PATCH 10/18] Readded no-edit option for bugfixing --- entrypoint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index 978cd61..9920bbe 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -51,7 +51,7 @@ if _git_changed; then # Commit and push changes back if $INPUT_SAME_COMMIT; then echo "Amending the current commit..." - git commit --amend + git commit --amend --no-edit else if $INPUT_ONLY_CHANGED; then for file in $(git diff --name-only HEAD^..HEAD) From 25af1e5a4bcefbf2ac5ecc7b6d3b9f29823dc005 Mon Sep 17 00:00:00 2001 From: Conrad Date: Sat, 17 Oct 2020 20:12:34 +0200 Subject: [PATCH 11/18] Testing with git pull option --- entrypoint.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/entrypoint.sh b/entrypoint.sh index 9920bbe..27628e2 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -51,6 +51,7 @@ if _git_changed; then # Commit and push changes back if $INPUT_SAME_COMMIT; then echo "Amending the current commit..." + git pull git commit --amend --no-edit else if $INPUT_ONLY_CHANGED; then From 96faaba8df2a467ea54cacbb4062c06a86d457f9 Mon Sep 17 00:00:00 2001 From: Conrad Date: Sat, 17 Oct 2020 20:27:01 +0200 Subject: [PATCH 12/18] Testing with asterix add --- entrypoint.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/entrypoint.sh b/entrypoint.sh index 27628e2..a06a729 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -52,6 +52,7 @@ if _git_changed; then if $INPUT_SAME_COMMIT; then echo "Amending the current commit..." git pull + git add * git commit --amend --no-edit else if $INPUT_ONLY_CHANGED; then From fde6ec771e30fcbbc1cfdf0060bf64a77104aa64 Mon Sep 17 00:00:00 2001 From: Conrad Date: Sat, 17 Oct 2020 20:44:21 +0200 Subject: [PATCH 13/18] Testing with force push option --- entrypoint.sh | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/entrypoint.sh b/entrypoint.sh index a06a729..19354d5 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -51,8 +51,6 @@ if _git_changed; then # Commit and push changes back if $INPUT_SAME_COMMIT; then echo "Amending the current commit..." - git pull - git add * git commit --amend --no-edit else if $INPUT_ONLY_CHANGED; then @@ -66,7 +64,7 @@ if _git_changed; then fi 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" fi - git push origin + git push -f origin echo "Changes pushed successfully." fi else From a3fd60656cdc2a154b7b5fd172ed1c191377b7b1 Mon Sep 17 00:00:00 2001 From: Conrad Date: Sat, 17 Oct 2020 21:02:01 +0200 Subject: [PATCH 14/18] Readded pull for bugfixing --- entrypoint.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/entrypoint.sh b/entrypoint.sh index 19354d5..caedd45 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -51,6 +51,7 @@ if _git_changed; then # Commit and push changes back if $INPUT_SAME_COMMIT; then echo "Amending the current commit..." + git pull git commit --amend --no-edit else if $INPUT_ONLY_CHANGED; then From b3e124647264531116381ac5c3f58c30c91b75f8 Mon Sep 17 00:00:00 2001 From: Conrad Date: Sat, 17 Oct 2020 21:04:19 +0200 Subject: [PATCH 15/18] Removed force push because of extreme danger --- entrypoint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index caedd45..27628e2 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -65,7 +65,7 @@ if _git_changed; then fi 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" fi - git push -f origin + git push origin echo "Changes pushed successfully." fi else From 3c5eb02712602a998826b052241c54a050d54d14 Mon Sep 17 00:00:00 2001 From: jorenbroekema Date: Sat, 17 Oct 2020 21:50:28 +0200 Subject: [PATCH 16/18] fix: force push when using same_commit option since we amend --- entrypoint.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index 27628e2..90db9c1 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -53,6 +53,7 @@ if _git_changed; then echo "Amending the current commit..." git pull git commit --amend --no-edit + git push origin -f else if $INPUT_ONLY_CHANGED; then for file in $(git diff --name-only HEAD^..HEAD) @@ -64,8 +65,8 @@ if _git_changed; then git add "${INPUT_FILE_PATTERN}" || echo "Problem adding your files with pattern ${INPUT_FILE_PATTERN}" fi 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 - git push origin echo "Changes pushed successfully." fi else From 30127fcc3c17f0455a51193ce565a99c93462d5d Mon Sep 17 00:00:00 2001 From: jorenbroekema Date: Sun, 18 Oct 2020 14:26:33 +0200 Subject: [PATCH 17/18] fix: add commit and push logic after git add logic --- entrypoint.sh | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/entrypoint.sh b/entrypoint.sh index 90db9c1..b9f430d 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -48,6 +48,17 @@ if _git_changed; then else # Calling method to configure the git environemnt _git_setup + + if $INPUT_ONLY_CHANGED; then + for file in $(git diff --name-only 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 if $INPUT_SAME_COMMIT; then echo "Amending the current commit..." @@ -55,15 +66,6 @@ if _git_changed; then git commit --amend --no-edit git push origin -f else - if $INPUT_ONLY_CHANGED; then - for file in $(git diff --name-only 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 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 From 173a5890f785540343e026fd825b526b38579624 Mon Sep 17 00:00:00 2001 From: Conrad Date: Sun, 18 Oct 2020 19:15:33 +0200 Subject: [PATCH 18/18] Improved documentation for latest release --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a343fd3..8e67ff7 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,11 @@ A GitHub action for styling files with [prettier](https://prettier.io). | 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 | -| same_commit | :x: | False | Update the current commit instead of creating a new one, created by [Joren Broekema](https://github.com/jorenbroekema) | +| 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 (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 | -| 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' (Example 2)| +| 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. @@ -61,7 +61,7 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` -#### Example 2 (using the only_changed option on PR) +#### Example 2 (using the only_changed or same_commit option on PR) ```yaml name: Continuous Integration @@ -87,6 +87,7 @@ jobs: 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 }} ```