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

Using latest version in the examples

Browse Source
This commit is contained in:
Conrad
2022-01-15 22:13:48 +01:00
parent 607ddfdc57
commit ac20e98371
1 changed files with 55 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -7,7 +7,6 @@
[![Contributors](https://img.shields.io/github/contributors-anon/creyD/prettier_action)](https://github.com/creyD/prettier_action/graphs/contributors) [![Contributors](https://img.shields.io/github/contributors-anon/creyD/prettier_action)](https://github.com/creyD/prettier_action/graphs/contributors)
[![Issues](https://img.shields.io/github/issues/creyD/prettier_action)](https://github.com/creyD/prettier_action/issues) [![Issues](https://img.shields.io/github/issues/creyD/prettier_action)](https://github.com/creyD/prettier_action/issues)
A GitHub action for styling files with [prettier](https://prettier.io). A GitHub action for styling files with [prettier](https://prettier.io).
## Usage ## Usage
@@ -35,7 +34,9 @@ A GitHub action for styling files with [prettier](https://prettier.io).
### Example Config ### 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. > 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) #### Example 1 (run on push in branch main)
```yaml ```yaml
name: Continuous Integration name: Continuous Integration
@@ -58,13 +59,14 @@ jobs:
ref: ${{ github.head_ref }} ref: ${{ github.head_ref }}
- name: Prettify code - name: Prettify code
uses: creyD/prettier_action@v4.1.1 uses: creyD/prettier_action@v4.2
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}
``` ```
#### Example 2 (using the only_changed or same_commit option on PR) #### Example 2 (using the only_changed or same_commit option on PR)
```yaml ```yaml
name: Continuous Integration name: Continuous Integration
@@ -86,7 +88,7 @@ jobs:
fetch-depth: 0 fetch-depth: 0
- name: Prettify code - name: Prettify code
uses: creyD/prettier_action@v4.1.1 uses: creyD/prettier_action@v4.2
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}
@@ -94,6 +96,7 @@ jobs:
``` ```
#### Example 3 (using a custom access token on PR) #### Example 3 (using a custom access token on PR)
```yaml ```yaml
name: Continuous Integration name: Continuous Integration
@@ -115,7 +118,7 @@ jobs:
persist-credentials: false persist-credentials: false
- name: Prettify code - name: Prettify code
uses: creyD/prettier_action@v4.1 uses: creyD/prettier_action@v4.2
with: with:
prettier_options: --write **/*.{js,md} prettier_options: --write **/*.{js,md}
only_changed: True only_changed: True
@@ -124,6 +127,7 @@ jobs:
``` ```
#### Example 4 (dry run) #### Example 4 (dry run)
```yaml ```yaml
name: Continuous Integration name: Continuous Integration
@@ -145,7 +149,7 @@ jobs:
persist-credentials: false persist-credentials: false
- name: Prettify code - name: Prettify code
uses: creyD/prettier_action@v4.1 uses: creyD/prettier_action@v4.2
with: with:
dry: True dry: True
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }} github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}