{"id":15691624,"url":"https://github.com/gaurav-nelson/github-action-vale-lint","last_synced_at":"2025-05-08T01:13:52.907Z","repository":{"id":65159869,"uuid":"177936583","full_name":"gaurav-nelson/github-action-vale-lint","owner":"gaurav-nelson","description":"⛔️ DEPRECATED ~~ GitHub action lint with Vale ✅❎ ~~ DEPRECATED ⛔️ ","archived":false,"fork":false,"pushed_at":"2020-04-14T23:52:45.000Z","size":678,"stargazers_count":12,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-08T01:13:45.315Z","etag":null,"topics":["actions","archived","deprecated","lint","obsolete","vale"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gaurav-nelson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-27T07:00:05.000Z","updated_at":"2025-03-05T08:49:47.000Z","dependencies_parsed_at":"2023-01-13T15:43:39.157Z","dependency_job_id":null,"html_url":"https://github.com/gaurav-nelson/github-action-vale-lint","commit_stats":{"total_commits":19,"total_committers":3,"mean_commits":6.333333333333333,"dds":0.5789473684210527,"last_synced_commit":"0cb8310cbe4133c5ba2161ab1132e056261c68ae"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaurav-nelson%2Fgithub-action-vale-lint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaurav-nelson%2Fgithub-action-vale-lint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaurav-nelson%2Fgithub-action-vale-lint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaurav-nelson%2Fgithub-action-vale-lint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gaurav-nelson","download_url":"https://codeload.github.com/gaurav-nelson/github-action-vale-lint/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252978783,"owners_count":21834917,"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":["actions","archived","deprecated","lint","obsolete","vale"],"created_at":"2024-10-03T18:22:33.495Z","updated_at":"2025-05-08T01:13:52.882Z","avatar_url":"https://github.com/gaurav-nelson.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)\n# DEPRECATED ⛔️ \nUse the official Vale action available at https://github.com/errata-ai/vale-action\n\n## Github action: Lint with Vale ✅❎\n\nAutomatically lint all modified text files in your GitHub pull requests. This GitHub action uses [Vale](https://errata-ai.github.io/vale/) to lint prose.\n\n![Lint with Vale](https://raw.githubusercontent.com/gaurav-nelson/github-action-vale-lint/master/images/lint-with-vale.png)\n\nThe `github-action-vale-lint` checks all modified text (including markup) files and reports failure on error. \n\n![Vale error list](https://raw.githubusercontent.com/gaurav-nelson/github-action-vale-lint/master/images/vale-error-list.png)\n\n## Prerequisite\nYou must have [Vale configuration file](https://errata-ai.github.io/vale/config/) `.vale.ini` in your repository.\n\n## How to use\n1. Create a new file in your repository `.github/workflows/action.yml`.\n   ```bash\n   touch .github/workflows/pull_request.yml\n   ```\n1. Copy-paste the folloing workflow in your `pull_request.yml` file:\n\n   ```yml\n   name: Lint PRs with Vale\n   on: pull_request\n   jobs:\n     vale-lint-PR:\n       runs-on: ubuntu-latest\n       steps:\n       - uses: actions/checkout@master\n         with:\n           fetch-depth: 1\n       - uses: gaurav-nelson/github-action-vale-lint@v0.1.0\n         env:\n           GH_COMMENT_TOKEN: ${{ secrets.GH_COMMENT_TOKEN }}\n   ```\n1. Or, if you want to lint all files (or files in a specific folder)\n   and not just modified files, use the following workflow in your\n   `pull_request.yml` file:\n\n   ```yml\n   name: Lint PRs with Vale\n   on: pull_request\n   jobs:\n     vale-lint-PR:\n       runs-on: ubuntu-latest\n       steps:\n       - uses: actions/checkout@master\n         with:\n           fetch-depth: 1\n       - uses: gaurav-nelson/github-action-vale-lint@v0.1.0\n         with:\n           lint-all-files: 'yes' \n           dir-to-lint: 'directory/path/to/lint'\n         env:\n           GH_COMMENT_TOKEN: ${{ secrets.GH_COMMENT_TOKEN }}\n   ```\n\n### Add Vale errors as comments on PR\nIf you want to show errors as comments on the pull request, in your repository:\n1. Go to **Settings** \u003e **Secrets**, and slect **Add a new secret**.\n1. Enter **GH_COMMENT_TOKEN** for **Name**, and enter your secret token as\n   **Value**.\n1. Select **Add secret**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgaurav-nelson%2Fgithub-action-vale-lint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgaurav-nelson%2Fgithub-action-vale-lint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgaurav-nelson%2Fgithub-action-vale-lint/lists"}