https://github.com/simbo/vale-action
A GitHub action to run Vale for spell-checking - much faster than the original action.
https://github.com/simbo/vale-action
action github-actions reviewdog spellchecking vale
Last synced: 3 months ago
JSON representation
A GitHub action to run Vale for spell-checking - much faster than the original action.
- Host: GitHub
- URL: https://github.com/simbo/vale-action
- Owner: simbo
- License: mit
- Created: 2022-08-31T08:08:56.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-30T09:13:28.000Z (over 2 years ago)
- Last Synced: 2024-09-19T03:17:07.030Z (about 1 year ago)
- Topics: action, github-actions, reviewdog, spellchecking, vale
- Language: Shell
- Homepage:
- Size: 20.5 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# simbo/vale-action
A GitHub action to run [Vale](https://vale.sh/) for spell-checking with optional
[Reviewdog](https://github.com/reviewdog/reviewdog) integration.
It does pretty much the same like the [official Vale action](https://github.com/errata-ai/vale-action),
but as this one is not using Docker, it's much faster.
## Usage
Use `simbo/vale-action@v1` in your GitHub action workflow.
Your project should have a [`vale.ini`](https://vale.sh/docs/vale-cli/structure/).
### Example
```yml
jobs:
notify:
runs-on: ubuntu-latest
steps:
- name: 🛎 Checkout
uses: actions/checkout@v3
- name: 🧑🏫 Spell-Check
env:
GITHUB_TOKEN: ${{ github.token }}
uses: simbo/vale-action@v1
```
## Inputs
| Input | Required | Default | Description |
| ---------------- | -------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `version` | no | (latest) | Vale release version to use. |
| `flags` | no | `''` | Space-delimited list of flags for the Vale CLI. To see a full list of available flags, run `vale -h`. |
| `files` | no | `'.'` | Space-delimited list of file or directory arguments; equivalent to calling `vale input1 input2`. |
| `reviewdog` | no | `'false'` | Whether to use Vale with Reviewdog. |
| `github_token` | no | `'${{ github.token }}'` | The GitHub repo access token to be used for Reviewdog. |
| `github_com_pat` | no | – | A GitHub.com PAT to avoid API rate limits |
| `reporter` | no | `'github-pr-review'` | Set the [reporter](https://github.com/reviewdog/reviewdog#reporters) type for Reviewdog. |
| `fail_on_error` | no | `'false'` | By default, Reviewdog will return exit code 0 even if it finds errors. If `fail_on_error` is enabled, Reviewdog exits with 1 when at least one error was reported. |
| `filter_mode` | no | `'added'` | Set the [filter mode](https://github.com/reviewdog/reviewdog#filter-mode) for Reviewdog. |
## Outputs
This action has no outputs. 🤷♂️
## Development
### Creating a new Version
Use `./release.sh ` which will create a git tag for the
respective version.
A release workflow will pick up the tag when pushed to GitHub, create a release
and move major, minor and latest tags accordingly.
To publish the release into the GitHub marketplace open
[releases](https://github.com/simbo/vale-action/releases) and
update the release for marketplace publishing.
## License
[MIT © Simon Lepel](http://simbo.mit-license.org/)