Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sonots/reviewdog-action-textlint
Run textlint with reviewdog
https://github.com/sonots/reviewdog-action-textlint
Last synced: about 2 months ago
JSON representation
Run textlint with reviewdog
- Host: GitHub
- URL: https://github.com/sonots/reviewdog-action-textlint
- Owner: sonots
- License: mit
- Created: 2020-11-11T14:57:27.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T12:54:03.000Z (almost 2 years ago)
- Last Synced: 2024-10-13T08:08:39.465Z (3 months ago)
- Language: TypeScript
- Size: 1.38 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# action-template
[](https://github.com/reviewdog/action-template/actions?query=workflow%3ATest)
[](https://github.com/reviewdog/action-template/actions?query=workflow%3Areviewdog)
[](https://github.com/reviewdog/action-template/actions?query=workflow%3Adepup)
[](https://github.com/reviewdog/action-template/actions?query=workflow%3Arelease)
[](https://github.com/reviewdog/action-template/releases)
[](https://github.com/haya14busa/action-bumpr)
This is a template repository for [reviewdog](https://github.com/reviewdog/reviewdog) action with release automation.
Click `Use this template` button to create your reviewdog action :dog:!
If you want to create your own reviewdog action from scratch without using this
template, please check and copy release automation flow.
It's important to manage release workflow and sync reviewdog version for all
reviewdog actions.
This repo contains a sample action to run [misspell](https://github.com/client9/misspell).
## Input
```yaml
inputs:
github_token:
description: 'GITHUB_TOKEN'
default: '${{ github.token }}'
workdir:
description: 'Working directory relative to the root directory.'
default: '.'
### Flags for reviewdog ###
level:
description: 'Report level for reviewdog [info,warning,error]'
default: 'error'
reporter:
description: 'Reporter of reviewdog command [github-pr-check,github-check,github-pr-review].'
default: 'github-pr-check'
filter_mode:
description: |
Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
Default is added.
default: 'added'
fail_on_error:
description: |
Exit code for reviewdog when errors are found [true,false]
Default is `false`.
default: 'false'
reviewdog_flags:
description: 'Additional reviewdog flags'
default: ''
### Flags for ###
locale:
description: '-locale flag of misspell. (US/UK)'
default: ''
```
## Usage
```yaml
name: reviewdog
on: [pull_request]
jobs:
# TODO: change `linter_name`.
linter_name:
name: runner /
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: reviewdog/action-template@v1
with:
github_token: ${{ secrets.github_token }}
# Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
reporter: github-pr-review
# Change reporter level if you need.
# GitHub Status Check won't become failure with warning.
level: warning
```
## Development
### Release
#### [haya14busa/action-bumpr](https://github.com/haya14busa/action-bumpr)
You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch).
Pushing tag manually by yourself also work.
#### [haya14busa/action-update-semver](https://github.com/haya14busa/action-update-semver)
This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3.
ref: https://help.github.com/en/articles/about-actions#versioning-your-action
### Lint - reviewdog integration
This reviewdog action template itself is integrated with reviewdog to run lints
which is useful for Docker container based actions.
Supported linters:
- [reviewdog/action-shellcheck](https://github.com/reviewdog/action-shellcheck)
- [reviewdog/action-hadolint](https://github.com/reviewdog/action-hadolint)
- [reviewdog/action-misspell](https://github.com/reviewdog/action-misspell)
### Dependencies Update Automation
This repository uses [haya14busa/action-depup](https://github.com/haya14busa/action-depup) to update
reviewdog version.
[](https://github.com/reviewdog/action-template/pull/6)