From 173a5890f785540343e026fd825b526b38579624 Mon Sep 17 00:00:00 2001 From: Conrad Date: Sun, 18 Oct 2020 19:15:33 +0200 Subject: [PATCH] Improved documentation for latest release --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a343fd3..8e67ff7 100644 --- a/README.md +++ b/README.md @@ -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_options | :x: | `--write **/*.js` | Prettier options (by default it applies to the whole repository) | | 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` | | 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 | -| 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. @@ -61,7 +61,7 @@ jobs: 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 name: Continuous Integration @@ -87,6 +87,7 @@ jobs: with: # This part is also where you can pass other options, for example: prettier_options: --write **/*.{js,md} + only_changed: True env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ```