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

Updated docs

Browse Source
This commit is contained in:
Conrad
2020-05-04 13:56:28 +02:00
parent 0ba5bcfc18
commit b09ae6a0d6
1 changed files with 7 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -22,7 +22,7 @@ A GitHub action for styling files with [prettier](https://prettier.io).
| commit_options | :x: | - | Custom git commit options | | commit_options | :x: | - | Custom git commit options |
| commit_message | :x: | Prettified Code! | Custom git commit message | | commit_message | :x: | Prettified Code! | Custom git commit message |
| file_pattern | :x: | * | Custom git add file pattern | | file_pattern | :x: | * | Custom git add file pattern |
| branch | :white_check_mark: | - | 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. | | branch (depreciated with 3.0)| :white_check_mark: | - | 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. |
### Example Config ### Example Config
@@ -41,14 +41,13 @@ jobs:
steps: steps:
- name: Cloning the repository - name: Cloning the repository
uses: actions/checkout@v1 uses: actions/checkout@v2
with: with:
fetch-depth: 1 ref: ${{ github.head_ref }}
- name: Prettify the JS Code - name: Prettify the JS Code
uses: creyD/prettier_action@v2.1 uses: creyD/prettier_action@v3.0
with: with:
prettier_options: '--no-semi --write *.js' prettier_options: '--no-semi --write *.js'
branch: ${{ github.head_ref }}
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
@@ -68,14 +67,13 @@ jobs:
steps: steps:
- name: Cloning the repository - name: Cloning the repository
uses: actions/checkout@v1 uses: actions/checkout@v2
with: with:
fetch-depth: 1 ref: ${{ github.head_ref }}
- name: Prettify the JS Code - name: Prettify the JS Code
uses: creyD/prettier_action@v2.1 uses: creyD/prettier_action@v3.0
with: with:
prettier_options: '--no-semi --write *.js' prettier_options: '--no-semi --write *.js'
branch: master
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```