Skip to content

Commit 394fa2d

Browse files
authored
Merge pull request #29 from creyD/dev
Update for 3.1 release
2 parents cf1aa3d + de263be commit 394fa2d

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ A GitHub action for styling files with [prettier](https://prettier.io).
1616

1717
| Parameter | Required | Default | Description |
1818
| - | :-: | :-: | - |
19-
| dry | :x: | false | Runs the action in dry mode. Files wont get changed and the action fails if there are unprettified files. |
20-
| prettier_version | :x: | false | Specific prettier version (by default use latest) |
21-
| prettier_options | :x: | `--write **/*.js` | Prettier options (by default it applies to the whole repository) |
19+
| dry | :x: | `false` | Runs the action in dry mode. Files wont get changed and the action fails if there are unprettified files. |
20+
| prettier_version | :x: | `false` | Specific prettier version (by default use latest) |
21+
| prettier_options | :x: | `"--write **/*.js"` | Prettier options (by default it applies to the whole repository) |
2222
| commit_options | :x: | - | Custom git commit options |
23-
| same_commit | :x: | False | Update the current commit instead of creating a new one, created by [Joren Broekema](https://github.com/jorenbroekema), this command works only with the checkout action set to fetch depth '0' (see example 2) |
24-
| commit_message | :x: | Prettified Code! | Custom git commit message, will be ignored if used with `same_commit` |
25-
| file_pattern | :x: | * | Custom git add file pattern, can't be used with only_changed! |
23+
| same_commit | :x: | `false` | Update the current commit instead of creating a new one, created by [Joren Broekema](https://github.com/jorenbroekema), this command works only with the checkout action set to fetch depth '0' (see example 2) |
24+
| commit_message | :x: | `"Prettified Code!"` | Custom git commit message, will be ignored if used with `same_commit` |
25+
| file_pattern | :x: | `*` | Custom git add file pattern, can't be used with only_changed! |
2626
| branch (depreciated with 3.0)| :white_check_mark: | - | Always set this to `${{ github.head_ref }}` in order to work both with pull requests and push events |
27-
| only_changed | :x: | 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)|
27+
| only_changed | :x: | `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)|
2828

2929
> 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.
3030

0 commit comments

Comments
 (0)