You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Prettier Action
v2.2
A GitHub action for styling files with prettier.
| 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 | ✅ | - | 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. |
This is a small example of what your action.yml could look like (on pull request mode):
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/[email protected]
with:
prettier_options: '--no-semi --write *.js'
branch: ${{ github.head_ref }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}name: Prettier for JS Code
on:
push:
branches: [master]
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/[email protected]
with:
prettier_options: '--no-semi --write *.js'
branch: master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}More documentation for writing a workflow can be found here.
Please report all bugs and feature request using the GitHub issues function. Thanks!