mirror of
https://github.com/creyD/prettier_action.git
synced 2026-04-12 19:30:30 +02:00
Using latest version in the examples
This commit is contained in:
106
README.md
106
README.md
@@ -7,7 +7,6 @@
|
|||||||
[](https://github.com/creyD/prettier_action/graphs/contributors)
|
[](https://github.com/creyD/prettier_action/graphs/contributors)
|
||||||
[](https://github.com/creyD/prettier_action/issues)
|
[](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
|
||||||
|
|
||||||
@@ -44,27 +45,28 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
prettier:
|
prettier:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
# Make sure the actual branch is checked out when running on pull requests
|
# Make sure the actual branch is checked out when running on pull requests
|
||||||
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
|
||||||
|
|
||||||
@@ -77,23 +79,24 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
# Make sure the actual branch is checked out when running on pull requests
|
# Make sure the actual branch is checked out when running on pull requests
|
||||||
ref: ${{ github.head_ref }}
|
ref: ${{ github.head_ref }}
|
||||||
# This is important to fetch the changes to the previous commit
|
# This is important to fetch the changes to the previous commit
|
||||||
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}
|
||||||
only_changed: True
|
only_changed: True
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 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
|
||||||
|
|
||||||
@@ -106,24 +109,25 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
ref: ${{ github.head_ref }}
|
ref: ${{ github.head_ref }}
|
||||||
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
|
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
|
||||||
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
|
||||||
# Set your custom token
|
# Set your custom token
|
||||||
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
|
github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Example 4 (dry run)
|
#### Example 4 (dry run)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
name: Continuous Integration
|
name: Continuous Integration
|
||||||
|
|
||||||
@@ -136,19 +140,19 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
ref: ${{ github.head_ref }}
|
ref: ${{ github.head_ref }}
|
||||||
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
|
# Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
|
||||||
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 }}
|
||||||
```
|
```
|
||||||
|
|
||||||
More documentation for writing a workflow can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).
|
More documentation for writing a workflow can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).
|
||||||
|
|||||||
Reference in New Issue
Block a user