From e0cc3c23b5c95bbd1bd92bf447016d6344bfc2cf Mon Sep 17 00:00:00 2001 From: Ilir Bekteshi Date: Thu, 7 Oct 2021 09:39:57 +0200 Subject: [PATCH] Upd doc --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4a65f3c..c93405b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # GitHub YAMLlint -This action executes `yamllint` (https://github.com/adrienverge/yamllint) against file(s) or folder +This action executes `yamllint` (https://github.com/adrienverge/yamllint) against files or folder ## Usage @@ -23,7 +23,7 @@ Simple as: - `strict` - Return non-zero exit code on warnings as well as errors `[true,false] (default: false)` - `no_warnings` - Output only error level problems `[true,false] (default: false)` -**Note:** If `.yamllint` configuration file exists in your root folder, yamllint will automatically use it. +**Note:** If `.yamllint` configuration file exists in your root folder, yamllint automatically uses it. ### Outputs @@ -31,6 +31,8 @@ Simple as: `${{ steps..outputs.logfile }}` +**Note:** Each yamllint run (for example if you define multiple yamllint steps) has its own log + ### Example usage in workflow ```yaml @@ -49,7 +51,7 @@ jobs: config_file: .yamllint.yml ``` -Or just simply check all yaml files in the repository: +Or just simply lint all yaml files in the repository: ```yaml ---