From 5cea39febe4be1f917384e5810836e6cecfc186d Mon Sep 17 00:00:00 2001 From: Conrad Date: Fri, 16 Oct 2020 09:15:41 +0200 Subject: [PATCH 1/4] 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 2/4] 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 3/4] 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 4/4] 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}