This GitHub Action submits textlint review comments if there are violations.
Here is the sample repository I've set up the automation.
To set up the textlint, you need to
- set up textlint
- set up workflow
To set up textlint, we need package.json
, Dangerfile
and .textlintrc
. Here are the examples:
{
"name": "danger-textlint-actions-demo",
"version": "1.0.0",
"dependencies": {
"textlint": "^11.2.3",
"textlint-rule-preset-japanese": "^2.0.1"
}
}
textlint.max_severity = "warn"
textlint.lint
{
"filters": {},
"rules": {
"preset-japanese": true
}
}
An example workflow looks like this:
on: pull_request
name: textlint
jobs:
textlint:
name: textlint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: actions/setup-node@v1
with:
node-version: 10.*
- run: npm install
- name: danger
uses: yuichielectric/danger-textlint-actions@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}