mirror of
https://github.com/creyD/prettier_action.git
synced 2026-04-19 14:50:31 +02:00
Using latest version in the examples
This commit is contained in:
14
README.md
14
README.md
@@ -7,7 +7,6 @@
|
||||
[](https://github.com/creyD/prettier_action/graphs/contributors)
|
||||
[](https://github.com/creyD/prettier_action/issues)
|
||||
|
||||
|
||||
A GitHub action for styling files with [prettier](https://prettier.io).
|
||||
|
||||
## Usage
|
||||
@@ -35,7 +34,9 @@ A GitHub action for styling files with [prettier](https://prettier.io).
|
||||
### Example Config
|
||||
|
||||
> Hint: if you still use the old naming convention or generally a different branch name, please replace the `main` in the following configurations.
|
||||
|
||||
#### Example 1 (run on push in branch main)
|
||||
|
||||
```yaml
|
||||
name: Continuous Integration
|
||||
|
||||
@@ -58,13 +59,14 @@ jobs:
|
||||
ref: ${{ github.head_ref }}
|
||||
|
||||
- name: Prettify code
|
||||
uses: creyD/prettier_action@v4.1.1
|
||||
uses: creyD/prettier_action@v4.2
|
||||
with:
|
||||
# This part is also where you can pass other options, for example:
|
||||
prettier_options: --write **/*.{js,md}
|
||||
```
|
||||
|
||||
#### Example 2 (using the only_changed or same_commit option on PR)
|
||||
|
||||
```yaml
|
||||
name: Continuous Integration
|
||||
|
||||
@@ -86,7 +88,7 @@ jobs:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Prettify code
|
||||
uses: creyD/prettier_action@v4.1.1
|
||||
uses: creyD/prettier_action@v4.2
|
||||
with:
|
||||
# This part is also where you can pass other options, for example:
|
||||
prettier_options: --write **/*.{js,md}
|
||||
@@ -94,6 +96,7 @@ jobs:
|
||||
```
|
||||
|
||||
#### Example 3 (using a custom access token on PR)
|
||||
|
||||
```yaml
|
||||
name: Continuous Integration
|
||||
|
||||
@@ -115,7 +118,7 @@ jobs:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Prettify code
|
||||
uses: creyD/prettier_action@v4.1
|
||||
uses: creyD/prettier_action@v4.2
|
||||
with:
|
||||
prettier_options: --write **/*.{js,md}
|
||||
only_changed: True
|
||||
@@ -124,6 +127,7 @@ jobs:
|
||||
```
|
||||
|
||||
#### Example 4 (dry run)
|
||||
|
||||
```yaml
|
||||
name: Continuous Integration
|
||||
|
||||
@@ -145,7 +149,7 @@ jobs:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Prettify code
|
||||
uses: creyD/prettier_action@v4.1
|
||||
uses: creyD/prettier_action@v4.2
|
||||
with:
|
||||
dry: True
|
||||
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
|
||||
|
||||
Reference in New Issue
Block a user