action-textlint use textlint within npm ecosystem.
This action runs textlint with reviewdog on pull requests to improve text review experience.
based on reviewdog/action-vint
Notice:
This action is composition action. It need npm ci.
You accept below one:
- Your workflow manually setup to run
npm ci. - This action automatic run
npm ci.
Required. Default is ${{ github.token }}.
Optional. Report level for reviewdog [info,warning,error].
It's same as -level flag of reviewdog.
Reporter of reviewdog command [github-pr-check,github-check,github-pr-review].
Default is github-pr-review.
It's same as -reporter flag of reviewdog.
github-pr-review can use Markdown and add a link to rule page in reviewdog reports.
Optional. Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is added.
Optional. Exit code for reviewdog when errors are found [true,false]
Default is false.
Optional. Additional reviewdog flags
textlint arguments (i.e. target dir:doc/*)
Optional. Package manager used in the repository [npm,yarn,pnpm]
Default is npm.
.textlintrc put in your repo.
And need textlint included in project package.json .
name: reviewdog
on: [pull_request]
jobs:
textlint:
name: runner / textlint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
submodules: true
- name: Setup node/npm
uses: actions/setup-node@v1
with:
node-version: '15'
- name: textlint-github-pr-check
uses: tsuyoshicho/action-textlint@v3
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-check
textlint_flags: "doc/**"
- name: textlint-github-check
uses: tsuyoshicho/action-textlint@v3
with:
github_token: ${{ secrets.github_token }}
reporter: github-check
textlint_flags: "doc/**"
- name: textlint-github-pr-review
uses: tsuyoshicho/action-textlint@v3
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review
textlint_flags: "doc/**"![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent