gulpjs / prettier_action

GitHub action for running prettier on your projects pull requests

GitHub Prettier Action

A GitHub action for styling files with prettier.

Usage

Parameters

Parameter	Required	Default	Description
dry	❌	False	Runs the action in dry mode. Files wont get changed and the action fails if there are unprettified files.
prettier_version	❌	False	Specific prettier version (by default use latest)
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 (depreciated with 3.0)	✅	-	Always set this to ${{ github.head_ref }} in order to work both with pull requests and push events

Example Config

name: Continuous Integration

# This action works with pull requests and pushes
on:
  pull_request:
  push:
    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 }}

    - name: Prettify code
      uses: creyD/prettier_action@v2.2
      with:
        # This part is also where you can pass other options, for example:
        prettier_options: --write **/*.{js,md}

More documentation for writing a workflow can be found here.

Issues

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