Skip to content

Commit

Permalink
Showing 2 changed files with 91 additions and 1 deletion.
15 changes: 15 additions & 0 deletions .github/workflows/update_semver.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Update Semver
on:
push:
branches-ignore:
- '**'
tags:
- 'v*.*.*'
jobs:
update-semver:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: haya14busa/action-update-semver@v1
with:
github_token: ${{ secrets.github_token }}
77 changes: 76 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,78 @@
# GitHub Action: Run textlint with reviewdog

based on reviewdog/action-eslint
[![Docker Image CI](https://github.com/tsuyoshicho/action-textlint/workflows/Docker%20Image%20CI/badge.svg)](https://github.com/tsuyoshicho/action-textlint/actions)
[![Release](https://img.shields.io/github/release/tsuyoshicho/action-textlint.svg?maxAge=43200)](https://github.com/tsuyoshicho/action-textlint/releases)

This action runs [textlint](https://github.com/textlint/textlint) with
[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve
text review experience.

based on [reviewdog/action-vint](https://github.com/reviewdog/action-vint)

```
After caputring work to add below
[![github-pr-check example]()]()
[![github-pr-review example]()]()
```

## Inputs

### `github_token`

**Required**. Must be in form of `github_token: ${{ secrets.github_token }}`'.

### `level`

Optional. Report level for reviewdog [info,warning,error].
It's same as `-level` flag of reviewdog.

### `reporter`

Reporter of reviewdog command [github-pr-check,github-pr-review].
Default is github-pr-check.
github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

### `textlint_flags`

textlint arguments (i.e. target dir:`doc/*`)

## Customizes

`.textlintrc` put in your repo.

## Example usage

### [.github/workflows/reviewdog.yml](.github/workflows/reviewdog.yml)

```yml
name: reviewdog
on: [pull_request]
jobs:
textlint:
name: runner / textlint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
name: reviewdog
on: [pull_request]
jobs:
textlint:
name: runner / textlint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
with:
submodules: true
- name: textlint-github-pr-check
uses: tsuyoshicho/action-textlint@v1
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-check
textlint_flags: "doc/*"
- name: textlint-github-pr-review
uses: tsuyoshicho/action-textlint@v1
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review
textlint_flags: "doc/*"
```

0 comments on commit 734523c

Please sign in to comment.