actions/yamllint
actions/yamllint
1
0
Fork 0
mirror of https://github.com/ibiqlik/action-yamllint.git synced 2024-11-21 22:00:57 -05:00
Code Issues Projects Releases Packages Wiki Activity

Upd doc

Browse source
This commit is contained in:
Ilir Bekteshi 2021-10-07 09:39:57 +02:00
parent 5ae2508648
commit e0cc3c23b5
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -1,6 +1,6 @@
# GitHub YAMLlint # 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 ## Usage
@ -23,7 +23,7 @@ Simple as:
- `strict` - Return non-zero exit code on warnings as well as errors `[true,false] (default: false)` - `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)` - `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 ### Outputs
@ -31,6 +31,8 @@ Simple as:
`${{ steps.<step>.outputs.logfile }}` `${{ steps.<step>.outputs.logfile }}`
**Note:** Each yamllint run (for example if you define multiple yamllint steps) has its own log
### Example usage in workflow ### Example usage in workflow
```yaml ```yaml
@ -49,7 +51,7 @@ jobs:
config_file: .yamllint.yml 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 ```yaml
--- ---