Merge pull request #15 from creyD/dev

Updated docs

Dockerfile

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

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Conrad
+Copyright (c) 2020 Conrad Großer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -14,7 +14,7 @@ copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

README.md

@@ -1,5 +1,13 @@
 # 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).
 
 ## Usage
@@ -8,41 +16,46 @@ A GitHub action for styling files with [prettier](https://prettier.io).
 
 | Parameter | Required | Default | Description |
 | - | :-: | :-: | - |
-| prettier_options | :x: | --write **/*.js | Prettier options (by default it applies to the whole repository) |
-| commit_options | :x: | No options. | Custom git commit options |
+| 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: | - | Custom git publish branch, use ${{ github.head_ref }} if used in pull requests |
+| 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
 
-This is a small example of what your `action.yml` could look like:
-
 ```yaml
-name: Prettier for JS Code
+name: Continuous Integration
 
-on: [pull_request]
+# This action works with pull requests and pushes
+on:
+  pull_request:
+  push:
+    branches:
+    - master
 
 jobs:
-  cleanup_tasks:
+  prettier:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Cloning the repository
-      uses: actions/checkout@v1
+    - name: Checkout
+      uses: actions/checkout@v2
       with:
-        fetch-depth: 1
-    - name: Prettify the JS Code
-      uses: creyD/prettier_action@v1.0
+        # Make sure the actual branch is checked out when running on pull requests
+        ref: ${{ github.head_ref }}
+
+    - name: Prettify code
+      uses: creyD/prettier_action@v2.2
       with:
-        prettier_options: '--no-semi --write src/**/*.js'
-        branch: ${{ github.head_ref }}
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        # This part is also where you can pass other options, for example:
+        prettier_options: --write **/*.{js,md}
 ```
 
-This simple example executes `prettier --no-semi --write src/**/*.js` after someone created a Pull Request on your repository. More documentation can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).
+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/prettier_action/issues/new).
+Please report all bugs and feature request using the [GitHub issues function](https://github.com/creyD/prettier_action/issues/new). Thanks!

action.yml

@@ -1,5 +1,5 @@
-name: "Prettier Action"
-description: "Automatically runs prettier on all your pull requests."
+name: Prettier Action
+description: Automatically runs prettier on all your changes.
 
 author: Conrad Großer <grosserconrad@gmail.com>
 
@@ -7,32 +7,31 @@ inputs:
   commit_message:
     description: Commit message
     required: false
-    default: "Prettified Code!"
+    default: 'Prettified Code!'
   commit_options:
     description: Commit options
     required: false
   file_pattern:
-    description: File pattern used for "git add"
+    description: File pattern used for `git add`
     required: false
-    default: "*"
+    default: '*'
   prettier_options:
-    description: Options for the 'prettier' command
+    description: Options for the `prettier` command
     required: false
-    default: "--write **/*.js"
-  branch:
-    description: Branch which the changes are merged to
-    required: true
+    default: '--write **/*.js'
+  dry:
+    description: Running the script in dry mode just shows whether there are files that should be prettified or not
+    required: false
+    default: false
+  prettier_version:
+    description: Specific version of prettier (by default just use the latest version)
+    required: false
+    default: false
 
 runs:
-  using: "docker"
-  image: "Dockerfile"
-  args:
-    - ${{ inputs.commit_message }}
-    - ${{ inputs.commit_options }}
-    - ${{ inputs.file_pattern }}
-    - ${{ inputs.prettier_options }}
-    - ${{ inputs.branch }}
+  using: 'docker'
+  image: 'Dockerfile'
 
 branding:
-  icon: "award"
-  color: "green"
+  icon: 'award'
+  color: 'green'

entrypoint.sh

@@ -1,41 +1,62 @@
 #!/bin/sh
-# e is for exiting the script automatically if a command fails, u is for exiting if a variable is not set, x is for showing the commands before they are executed
-set -eux
+# 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
 
+# 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)
-git_setup ( ) {
-  cat <<- EOF > $HOME/.netrc
-        machine github.com
-        login $GITHUB_ACTOR
-        password $GITHUB_TOKEN
-        machine api.github.com
-        login $GITHUB_ACTOR
-        password $GITHUB_TOKEN
+_git_setup ( ) {
+    cat <<- EOF > $HOME/.netrc
+      machine github.com
+      login $GITHUB_ACTOR
+      password $GITHUB_TOKEN
+      machine api.github.com
+      login $GITHUB_ACTOR
+      password $GITHUB_TOKEN
 EOF
     chmod 600 $HOME/.netrc
 
     git config --global user.email "actions@github.com"
-    git config --global user.name "GitHub Actions"
+    git config --global user.name "GitHub Action"
 }
 
-echo "Installing prettier..."
-npm install --silent --global prettier
-echo "Prettifing files..."
-prettier $INPUT_PRETTIER_OPTIONS || echo "Problem while prettifying your files!"
+# Checks if any files are changed
+_git_changed() {
+    [[ -n "$(git status -s)" ]]
+}
 
-if ! git diff --quiet
+# PROGRAM
+echo "Installing 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:"
+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
-  echo "Commiting and pushing changes..."
-  # Calling method to configure the git environemnt
-  git_setup
-  # Switch to the actual branch
-  git checkout $INPUT_BRANCH
-  # Add changes to git
-  git add "${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 --set-upstream origin "HEAD:$INPUT_BRANCH"
-  echo "Changes pushed successfully."
+  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}"
+    # 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
+    echo "Changes pushed successfully."
+  fi
 else
   echo "Nothing to commit. Exiting."
 fi