Merge pull request #15 from creyD/dev

Updated docs

README.md

@@ -1,6 +1,12 @@
 # GitHub Prettier Action
 
 [![CodeFactor](https://www.codefactor.io/repository/github/creyd/prettier_action/badge/master)](https://www.codefactor.io/repository/github/creyd/prettier_action/overview/master)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![License MIT](https://img.shields.io/github/license/creyD/prettier_action)](https://github.com/creyD/prettier_action/blob/master/LICENSE)
+[![Latest Release](https://img.shields.io/github/v/release/creyD/prettier_action)](https://github.com/creyD/prettier_action/releases)
+[![Contributors](https://img.shields.io/github/contributors-anon/creyD/prettier_action)](https://github.com/creyD/prettier_action/graphs/contributors)
+[![Issues](https://img.shields.io/github/issues/creyD/prettier_action)](https://github.com/creyD/prettier_action/issues)
+
 
 A GitHub action for styling files with [prettier](https://prettier.io).
 
@@ -11,66 +17,41 @@ 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) |
 | 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 | :white_check_mark: | - | There are two types of action triggers in GitHub: on pull request and on push. The branch needs to be defined for both, but in case of the pull request trigger it should have `${{ github.head_ref }}` and on push it should have the branch the trigger is designed for. |
+| 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 |
 
 ### Example Config
 
-#### Example - On Pull Request
-
-This is a small example of what your `action.yml` could look like (on pull request mode):
-
 ```yaml
-name: Prettier for JS Code
+name: Continuous Integration
-
-on: [pull_request]
-
-jobs:
-  cleanup_tasks:
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Cloning the repository
-      uses: actions/checkout@v1
-      with:
-        fetch-depth: 1
-    - name: Prettify the JS Code
-      uses: creyD/prettier_action@v2.0
-      with:
-        prettier_options: '--no-semi --write *.js'
-        branch: ${{ github.head_ref }}
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-
-#### Example - On Push
-
-```yaml
-name: Prettier for JS Code
 
+# This action works with pull requests and pushes
 on:
+  pull_request:
   push:
-    branches: [master]
+    branches:
+    - master
 
 jobs:
-  cleanup_tasks:
+  prettier:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Cloning the repository
+    - name: Checkout
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
       with:
-        fetch-depth: 1
+        # Make sure the actual branch is checked out when running on pull requests
-    - name: Prettify the JS Code
+        ref: ${{ github.head_ref }}
-      uses: creyD/prettier_action@v2.0
+
+    - name: Prettify code
+      uses: creyD/prettier_action@v2.2
       with:
-        prettier_options: '--no-semi --write *.js'
+        # This part is also where you can pass other options, for example:
-        branch: master
+        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).

action.yml

@@ -19,13 +19,14 @@ inputs:
     description: Options for the `prettier` command
     required: false
     default: '--write **/*.js'
-  branch:
-    description: Target branch for the changes
-    required: true
   dry:
     description: Running the script in dry mode just shows whether there are files that should be prettified or not
     required: false
-    default: False
+    default: false
+  prettier_version:
+    description: Specific version of prettier (by default just use the latest version)
+    required: false
+    default: false
 
 runs:
   using: 'docker'

entrypoint.sh

@@ -25,19 +25,16 @@ _git_changed() {
     [[ -n "$(git status -s)" ]]
 }
 
-# Pushes to the according upstream (origin or input branch)
-_git_push() {
-    if [ -z "$INPUT_BRANCH" ]
-    then
-        git push origin
-    else
-        git push --set-upstream origin "HEAD:$INPUT_BRANCH"
-    fi
-}
-
 # PROGRAM
 echo "Installing prettier..."
-npm install --silent --global prettier
+case $INPUT_PRETTIER_VERSION in
+    false)
+        npm install --silent --global prettier
+        ;;
+    *)
+        npm install --silent --global prettier@$INPUT_PRETTIER_VERSION
+        ;;
+esac
 
 echo "Prettifing files..."
 echo "Files:"
@@ -47,19 +44,17 @@ prettier $INPUT_PRETTIER_OPTIONS || echo "Problem running prettier with $INPUT_P
 if _git_changed;
 then
   if $INPUT_DRY; then
-    echo "Prettier found unpretty files."
+    echo "Prettier found unpretty files!"
     exit 1
   else
     # Calling method to configure the git environemnt
     _git_setup
     echo "Commiting and pushing changes..."
-    # Switch to the actual branch
-    git checkout $INPUT_BRANCH || echo "Problem checking out the specified branch: $INPUT_BRANCH"
     # 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
+    git push origin
     echo "Changes pushed successfully."
   fi
 else