prettier_action/README.md

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, can't be used with only_changed!
branch (depreciated with 3.0)	✅	-	Always set this to ${{ github.head_ref }} in order to work both with pull requests and push events
only_changed	❌	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)

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@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)

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}
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

More documentation for writing a workflow can be found here.

Issues

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