diff --git a/README.md b/README.md index 18055cb3..39aec0f6 100644 --- a/README.md +++ b/README.md @@ -28,17 +28,20 @@ jobs: > If you're using a markup format other than Markdown, you may need to install > an external parser. > -> For example, to use it with AsciiDoc add the following step to your workflow before calling `vale-action`: +> To use it with AsciiDoc, for example, add the following step to your workflow +> before calling `vale-action`: +> > ```yaml > - name: Install Asciidoctor > run: sudo apt-get install -y asciidoctor > ``` > -> For more information, see the [Vale documentation][2]. +> See the [Vale documentation][2] for more information. ## Repository Structure -The recommended repository structure makes use of the existing `.github` directory to hold all of our Vale-related resources: +The recommended repository structure makes use of the existing `.github` +directory to hold all of our Vale-related resources: ```text .github @@ -50,7 +53,8 @@ The recommended repository structure makes use of the existing `.github` directo ... ``` -Where `styles` represents your [`StylesPath`](https://docs.errata.ai/vale/styles). The top-level `.vale.ini` file should reference this directory: +Where `styles` represents your [`StylesPath`][3]. The top-level `.vale.ini` +file should reference this directory: ```ini StylesPath = .github/styles @@ -62,9 +66,11 @@ BasedOnStyles = Vale ## Inputs -You can further customize the linting processing by providing one of the following optional inputs. +You can further customize the linting processing by providing one of the +following optional inputs. -To add an input, edit your workflow file and add the `with` key to the `uses` block. For example: +To add an input, edit your workflow file and add the `with` key to the `uses` +block. For example: ```yaml - uses: errata-ai/vale-action@v2.1.1 @@ -94,13 +100,17 @@ with: You can supply this value one of four ways: -- `files: all` (default): The repo's root directory; equivalent to calling `vale .`. +- `files: all` (default): The repo's root directory; equivalent to calling +`vale .`. -- `files: path/to/lint`: A single file or directory; equivalent to calling `vale path/to/lint`. +- `files: path/to/lint`: A single file or directory; equivalent to calling +`vale path/to/lint`. -- `files: '["input1", "input2"]'`: A JSON-formatted list of file or directory arguments; equivalent to calling `vale input1 input2`. +- `files: '["input1", "input2"]'`: A JSON-formatted list of file or directory +arguments; equivalent to calling `vale input1 input2`. -- `files: 'input1,input2'`: A character-delimited list of files. The character is determined by the input value `separator`: +- `files: 'input1,input2'`: A character-delimited list of files. The character +is determined by the input value `separator`: ```yaml with: @@ -119,7 +129,8 @@ with: ### `fail_on_error` (default: 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 +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. ```yaml @@ -140,7 +151,8 @@ with: ### `vale_flags` (default: "") -Space-delimited list of flags for the Vale CLI. To see a full list of available flags, run `vale -h`. +Space-delimited list of flags for the Vale CLI. To see a full list of available +flags, run `vale -h`. Note that flags should not include quotes. So while `--glob='*.txt'` works with Vale, it does not work with this action. @@ -151,7 +163,7 @@ with: vale_flags: "--glob=*.txt" ``` -### `token` (default: [`secrets.GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)) +### `token` (default: [`secrets.GITHUB_TOKEN`][4]) The GitHub token to use. @@ -162,3 +174,5 @@ with: [1]: https://help.github.com/en/github/automating-your-workflow-with-github-actions/configuring-a-workflow [2]: https://vale.sh/docs/topics/scoping/#formats +[3]: https://vale.sh/docs/topics/styles/ +[4]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication