{"id":21158253,"url":"https://github.com/simbo/vale-action","last_synced_at":"2025-07-09T12:33:57.426Z","repository":{"id":65161760,"uuid":"530990624","full_name":"simbo/vale-action","owner":"simbo","description":"A GitHub action to run Vale for spell-checking - much faster than the original action.","archived":false,"fork":false,"pushed_at":"2023-05-30T09:13:28.000Z","size":21,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-09-19T03:17:07.030Z","etag":null,"topics":["action","github-actions","reviewdog","spellchecking","vale"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simbo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-08-31T08:08:56.000Z","updated_at":"2024-06-29T18:43:04.000Z","dependencies_parsed_at":"2023-01-13T15:44:31.682Z","dependency_job_id":null,"html_url":"https://github.com/simbo/vale-action","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fvale-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fvale-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fvale-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fvale-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simbo","download_url":"https://codeload.github.com/simbo/vale-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225551710,"owners_count":17487281,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["action","github-actions","reviewdog","spellchecking","vale"],"created_at":"2024-11-20T12:19:03.523Z","updated_at":"2024-11-20T12:19:04.113Z","avatar_url":"https://github.com/simbo.png","language":"Shell","readme":"# simbo/vale-action\n\nA GitHub action to run [Vale](https://vale.sh/) for spell-checking with optional\n[Reviewdog](https://github.com/reviewdog/reviewdog) integration.\n\nIt does pretty much the same like the [official Vale action](https://github.com/errata-ai/vale-action),\nbut as this one is not using Docker, it's much faster.\n\n## Usage\n\nUse `simbo/vale-action@v1` in your GitHub action workflow.\n\nYour project should have a [`vale.ini`](https://vale.sh/docs/vale-cli/structure/).\n\n### Example\n\n```yml\njobs:\n notify:\n runs-on: ubuntu-latest\n steps:\n - name: 🛎 Checkout\n uses: actions/checkout@v3\n\n - name: 🧑‍🏫 Spell-Check\n env:\n GITHUB_TOKEN: ${{ github.token }}\n uses: simbo/vale-action@v1\n```\n\n## Inputs\n\n| Input | Required | Default | Description |\n| ---------------- | -------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `version` | no | (latest) | Vale release version to use. |\n| `flags` | no | `''` | Space-delimited list of flags for the Vale CLI. To see a full list of available flags, run `vale -h`. |\n| `files` | no | `'.'` | Space-delimited list of file or directory arguments; equivalent to calling `vale input1 input2`. |\n| `reviewdog` | no | `'false'` | Whether to use Vale with Reviewdog. |\n| `github_token` | no | `'${{ github.token }}'` | The GitHub repo access token to be used for Reviewdog. |\n| `github_com_pat` | no | – | A GitHub.com PAT to avoid API rate limits |\n| `reporter` | no | `'github-pr-review'` | Set the [reporter](https://github.com/reviewdog/reviewdog#reporters) type for Reviewdog. |\n| `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. |\n| `filter_mode` | no | `'added'` | Set the [filter mode](https://github.com/reviewdog/reviewdog#filter-mode) for Reviewdog. |\n\n## Outputs\n\nThis action has no outputs. 🤷‍♂️\n\n## Development\n\n### Creating a new Version\n\nUse `./release.sh \u003cmajor|minor|patch\u003e` which will create a git tag for the\nrespective version.\n\nA release workflow will pick up the tag when pushed to GitHub, create a release\nand move major, minor and latest tags accordingly.\n\nTo publish the release into the GitHub marketplace open\n[releases](https://github.com/simbo/vale-action/releases) and\nupdate the release for marketplace publishing.\n\n## License\n\n[MIT \u0026copy; Simon Lepel](http://simbo.mit-license.org/)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimbo%2Fvale-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimbo%2Fvale-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimbo%2Fvale-action/lists"}