prettier_action/README.md

GitHub Prettier Action

A GitHub action for styling files with prettier.

Usage

Parameters

Parameter	Required	Default	Description
prettier_options	❌	--write **/*.js	Prettier options (by default it applies to the whole repository)
commit_options	❌	-	Custom git commit options
commit_message	❌	Prettified Code!	Custom git commit message
file_pattern	❌	*	Custom git add file pattern
branch	✅	-	See note below! (TL;DR: On PR: ${{ github.head_ref }}\nOn Push: branch you are pushing to)

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.

Example Config

This is a small example of what your action.yml could look like:

name: Prettier for JS Code

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@v1.0
      with:
        prettier_options: '--no-semi --write src/**/*.js'
        branch: ${{ github.head_ref }}
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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.

Issues

Please report all bugs and feature request using the GitHub issues function.