creyD/prettier_action
1
0
Fork 0
mirror of https://github.com/creyD/prettier_action.git synced 2026-04-18 06:10:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improved documentation for latest release

Browse Source
This commit is contained in:
Conrad
2020-10-18 19:15:33 +02:00
parent fc18abc0ba
commit 173a5890f7
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -20,11 +20,11 @@ A GitHub action for styling files with [prettier](https://prettier.io).
| prettier_version | :x: | false | Specific prettier version (by default use latest) | | prettier_version | :x: | false | Specific prettier version (by default use latest) |
| prettier_options | :x: | `--write **/*.js` | Prettier options (by default it applies to the whole repository) | | prettier_options | :x: | `--write **/*.js` | Prettier options (by default it applies to the whole repository) |
| commit_options | :x: | - | Custom git commit options | | commit_options | :x: | - | Custom git commit options |
| same_commit | :x: | False | Update the current commit instead of creating a new one, created by [Joren Broekema](https://github.com/jorenbroekema) | | 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) |
| commit_message | :x: | Prettified Code! | Custom git commit message, will be ignored if used with `same_commit` | | commit_message | :x: | Prettified Code! | Custom git commit message, will be ignored if used with `same_commit` |
| file_pattern | :x: | * | Custom git add file pattern, can't be used with only_changed! | | file_pattern | :x: | * | Custom git add file pattern, can't be used with only_changed! |
| 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 | | 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 |
| 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' (Example 2)| | 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)|
> 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. > 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.
@@ -61,7 +61,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
#### Example 2 (using the only_changed option on PR) #### Example 2 (using the only_changed or same_commit option on PR)
```yaml ```yaml
name: Continuous Integration name: Continuous Integration
@@ -87,6 +87,7 @@ jobs:
with: with:
# This part is also where you can pass other options, for example: # This part is also where you can pass other options, for example:
prettier_options: --write **/*.{js,md} prettier_options: --write **/*.{js,md}
only_changed: True
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```