You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Prettier Action
v4.1.1
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. Recommended to use with prettier_options --check |
| prettier_version | ❌ | false |
Specific prettier version (by default use latest) |
| working_directory | ❌ | false |
Specify a directory to cd into before installing prettier and running it, use relative file path to the repository root for example app/ |
| prettier_options | ❌ | "--write **/*.js" |
Prettier options (by default it applies to the whole repository) |
| commit_options | ❌ | - | Custom git commit options |
| push_options | ❌ | - | Custom git push options |
| same_commit | ❌ | false |
Update the current commit instead of creating a new one, created by Joren Broekema, this command works only with the checkout action set to fetch depth '0' (see example 2) |
| commit_message | ❌ | "Prettified Code!" |
Custom git commit message, will be ignored if used with same_commit |
| commit_description | ❌ | - | Custom git extended commit message, will be ignored if used with same_commit |
| file_pattern | ❌ | * |
Custom git add file pattern, can't be used with only_changed! |
| prettier_plugins | ❌ | - | Install Prettier plugins, i.e. @prettier/plugin-php @prettier/plugin-other |
| 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' (see example 2) |
| github_token | ❌ | ${{ github.token }} |
The default GITHUB_TOKEN or a Personal Access Token |
Note: using the same_commit option may lead to problems if other actions are relying on the commit being the same before and after the prettier action has ran. Keep this in mind.
Hint: if you still use the old naming convention or generally a different branch name, please replace the
mainin the following configurations.
name: Continuous Integration
# This action works with pull requests and pushes
on:
pull_request:
push:
branches:
- main
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@v4.1
with:
# This part is also where you can pass other options, for example:
prettier_options: --write **/*.{js,md}name: Continuous Integration
on:
pull_request:
branches: [main]
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@v4.1
with:
# This part is also where you can pass other options, for example:
prettier_options: --write **/*.{js,md}
only_changed: Truename: Continuous Integration
on:
pull_request:
branches: [main]
jobs:
prettier:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
ref: ${{ github.head_ref }}
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
persist-credentials: false
- name: Prettify code
uses: creyD/prettier_action@v4.1
with:
prettier_options: --write **/*.{js,md}
only_changed: True
# Set your custom token
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}name: Continuous Integration
on:
pull_request:
branches: [main]
jobs:
prettier:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
ref: ${{ github.head_ref }}
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
persist-credentials: false
- name: Prettify code
uses: creyD/prettier_action@v4.1
with:
dry: True
github_token: ${{ secrets.PERSONAL_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!