From 4f6e0765de9e1198940b4a747890a2c426e5c00e Mon Sep 17 00:00:00 2001 From: blooper05 Date: Wed, 8 Jun 2022 11:59:33 +0900 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(actions):=20Sync=20`input`?= =?UTF-8?q?=20section=20of=20`action.yml`=20with=20that=20of=20`README.md`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c187969..ef1ba2d 100644 --- a/README.md +++ b/README.md @@ -21,39 +21,40 @@ code review experience. ```yaml inputs: github_token: - description: 'GITHUB_TOKEN' - default: '${{ github.token }}' + description: GITHUB_TOKEN + default: ${{ github.token }} workdir: - description: 'Working directory relative to the root directory.' - default: '.' + description: Working directory relative to the root directory. + default: . ### Flags for reviewdog ### tool_name: - description: 'Tool name to use for reviewdog reporter' - default: 'rails_best_practices' + description: Tool name to use for reviewdog reporter + default: rails_best_practices level: - description: 'Report level for reviewdog [info,warning,error]' - default: 'error' + description: Report level for reviewdog [info,warning,error] + default: error reporter: - description: 'Reporter of reviewdog command [github-check,github-pr-review,github-pr-check].' - default: 'github-check' + description: Reporter of reviewdog command [github-check,github-pr-review,github-pr-check]. + default: github-check filter_mode: description: | Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is added. - default: 'added' + default: added fail_on_error: description: | Exit code for reviewdog when errors are found [true,false] Default is `false`. default: 'false' reviewdog_flags: - description: 'Additional reviewdog flags' + description: Additional reviewdog flags default: '' ### Flags for rails_best_practices ### rails_best_practices_version: - description: 'rails_best_practices version' + description: rails_best_practices version rails_best_practices_flags: - description: 'rails_best_practices flags (rails_best_practices --without-color --silent . )' + description: | + rails_best_practices flags (rails_best_practices --without-color --silent . ) default: '' ```