{"id":13542693,"url":"https://github.com/errata-ai/vale-action","last_synced_at":"2025-05-15T16:06:08.122Z","repository":{"id":35711403,"uuid":"217354397","full_name":"errata-ai/vale-action","owner":"errata-ai","description":":octocat: The official GitHub Action for Vale -- install, manage, and run Vale with ease.","archived":false,"fork":false,"pushed_at":"2024-11-18T08:45:54.000Z","size":46066,"stargazers_count":217,"open_issues_count":18,"forks_count":53,"subscribers_count":7,"default_branch":"reviewdog","last_synced_at":"2025-05-05T19:47:07.875Z","etag":null,"topics":["github-actions","vale"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/errata-ai.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"open_collective":"vale","github":"jdkato"}},"created_at":"2019-10-24T17:22:41.000Z","updated_at":"2025-04-18T16:00:21.000Z","dependencies_parsed_at":"2023-02-15T13:31:48.485Z","dependency_job_id":"3d931bfa-a89d-446e-8001-4674f58dfc97","html_url":"https://github.com/errata-ai/vale-action","commit_stats":{"total_commits":162,"total_committers":21,"mean_commits":7.714285714285714,"dds":0.2592592592592593,"last_synced_commit":"2690bc95f0ed3cb5220492575af09c51b04fbea9"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":"actions/container-toolkit-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/errata-ai%2Fvale-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/errata-ai%2Fvale-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/errata-ai%2Fvale-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/errata-ai%2Fvale-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/errata-ai","download_url":"https://codeload.github.com/errata-ai/vale-action/tar.gz/refs/heads/reviewdog","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254374465,"owners_count":22060611,"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":["github-actions","vale"],"created_at":"2024-08-01T10:01:15.774Z","updated_at":"2025-05-15T16:06:08.102Z","avatar_url":"https://github.com/errata-ai.png","language":"TypeScript","funding_links":["https://opencollective.com/vale","https://github.com/sponsors/jdkato"],"categories":["TypeScript","others","GitHub Actions"],"sub_categories":[],"readme":"# GitHub Actions + Vale\n\n\u003e :octocat: The official GitHub Action for Vale -- install, manage, and run Vale\n\u003e with ease.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"50%\" alt=\"A demo screenshot.\" src=\"https://user-images.githubusercontent.com/8785025/85236358-272d3680-b3d2-11ea-8793-0f45cb70189a.png\"\u003e\n\u003c/p\u003e\n\n## Usage\n\nAdd the following (or similar) to one of your [`.github/workflows`][1] files:\n\n```yaml\nname: reviewdog\non: [pull_request]\n\njobs:\n  vale:\n    name: runner / vale\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - uses: errata-ai/vale-action@v2.1.1\n```\n\n\u003e [!TIP]\n\u003e If you're using a markup format other than Markdown, you may need to install\n\u003e an external parser before calling `vale-action`:\n\u003e\n\u003e ```yaml\n\u003e # For AsciiDoc users:\n\u003e - name: Install Asciidoctor\n\u003e   run: sudo apt-get install -y asciidoctor\n\u003e\n\u003e # For reStructuredText users:\n\u003e - name: Install docutils\n\u003e   run: sudo apt-get install -y docutils\n\u003e ```\n\u003e\n\u003e See the [Vale documentation][2] for more information.\n\n## Repository Structure\n\nThe recommended repository structure makes use of the existing `.github` \ndirectory to hold all of our Vale-related resources:\n\n```text\n.github\n├── styles\n│   └── vocab.txt\n└── workflows\n    └── main.yml\n.vale.ini\n...\n```\n\nWhere `styles` represents your [`StylesPath`][3]. The top-level `.vale.ini` \nfile should reference this directory:\n\n```ini\nStylesPath = .github/styles\nMinAlertLevel = suggestion\n\n[*.md]\nBasedOnStyles = Vale\n```\n\n## Inputs\n\nYou can further customize the linting processing by providing one of the \nfollowing optional inputs.\n\nTo add an input, edit your workflow file and add the `with` key to the `uses` \nblock. For example:\n\n```yaml\n- uses: errata-ai/vale-action@v2.1.1\n  with:\n    version: 2.17.0\n```\n\n### `version` (default: latest)\n\n\u003e NOTE: The provided version must be `\u003e= 2.16.0`.\n\nSpecify the Vale CLI version to use.\n\n```yaml\nwith:\n  version: 2.17.0\n```\n\n### `files` (default: all)\n\n`files` specifies where Vale will look for files to lint.\n\n```yaml\nwith:\n  files: path/to/lint\n```\n\nYou can supply this value one of four ways:\n\n- `files: all` (default): The repo's root directory; equivalent to calling \n`vale .`.\n\n- `files: path/to/lint`: A single file or directory; equivalent to calling \n`vale path/to/lint`.\n\n- `files: '[\"input1\", \"input2\"]'`: A JSON-formatted list of file or directory \narguments; equivalent to calling `vale input1 input2`.\n\n- `files: 'input1,input2'`: A character-delimited list of files. The character \nis determined by the input value `separator`:\n    \n    ```yaml\n    with:\n      separator: \",\"\n    ```\n\n### `reporter` (default: github-pr-check)\n\nSet the [reporter](https://github.com/reviewdog/reviewdog#reporters) type.\n\n```yaml\nwith:\n  # github-pr-check, github-pr-review, github-check\n  reporter: github-pr-check\n```\n\n### `fail_on_error` (default: false)\n\nBy default, `reviewdog` will return exit code `0` even if it finds errors. If \n`fail_on_error` is enabled, `reviewdog` exits with `1` when at least one error\nwas reported.\n\n```yaml\nwith:\n  fail_on_error: true\n```\n\n### `filter_mode` (default: added)\n\nSet the [filter mode](https://github.com/reviewdog/reviewdog#filter-mode) for\n`reviewdog`.\n\n```yaml\nwith:\n  # added, diff_context, file, nofilter\n  filter_mode: nofilter\n```\n\n### `vale_flags` (default: \"\")\n\nSpace-delimited list of flags for the Vale CLI. To see a full list of available \nflags, run `vale -h`.\n\nNote that flags should not include quotes.\nSo while `--glob='*.txt'` works with Vale, it does not work with this action.\nUse the flag without quotes, as in the following example:\n\n```yaml\nwith:\n  vale_flags: \"--glob=*.txt\"\n```\n\n### `token` (default: [`secrets.GITHUB_TOKEN`][4])\n\nThe GitHub token to use.\n\n```yaml\nwith:\n  token: ${{secrets.VALE_GITHUB_TOKEN}}\n```\n\n[1]: https://help.github.com/en/github/automating-your-workflow-with-github-actions/configuring-a-workflow\n[2]: https://vale.sh/docs/topics/scoping/#formats\n[3]: https://vale.sh/docs/topics/styles/\n[4]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferrata-ai%2Fvale-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferrata-ai%2Fvale-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferrata-ai%2Fvale-action/lists"}