mirror of
https://github.com/ibiqlik/action-yamllint.git
synced 2024-10-06 00:54:15 -04:00
105 lines
2.5 KiB
Markdown
105 lines
2.5 KiB
Markdown
# GitHub YAMLlint
|
|
|
|
This action executes `yamllint` (https://github.com/adrienverge/yamllint) against file(s) or folder
|
|
|
|
## Usage
|
|
|
|
Simple as:
|
|
|
|
```yaml
|
|
- uses: ibiqlik/action-yamllint@v3
|
|
```
|
|
|
|
### Optional input parameters
|
|
|
|
- `config_file` - Path to custom configuration
|
|
- `config_data` - Custom configuration (as YAML source)
|
|
- `file_or_dir` - Enter file/folder (space separated), wildcards accepted. Examples:
|
|
- `.` - run against all yaml files in a directory recursively (default)
|
|
- `file1.yaml`
|
|
- `file1.yaml file2.yaml`
|
|
- `kustomize/**/*.yaml mychart/*values.yaml`
|
|
- `format` - Format for parsing output `[parsable,standard,colored,github,auto] (default: parsable)`
|
|
- `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.
|
|
|
|
### Outputs
|
|
|
|
`logfile` - Path to yamllint log file
|
|
|
|
`${{ steps.<step>.outputs.logfile }}`
|
|
|
|
### Example usage in workflow
|
|
|
|
```yaml
|
|
---
|
|
name: Yaml Lint
|
|
on: [push] # yamllint disable-line rule:truthy
|
|
jobs:
|
|
lintAllTheThings:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v1
|
|
- name: yaml-lint
|
|
uses: ibiqlik/action-yamllint@v3
|
|
with:
|
|
file_or_dir: myfolder/*values*.yaml
|
|
config_file: .yamllint.yml
|
|
```
|
|
|
|
Or just simply check all yaml files in the repository:
|
|
|
|
```yaml
|
|
---
|
|
name: Yaml Lint
|
|
on: [push] # yamllint disable-line rule:truthy
|
|
jobs:
|
|
lintAllTheThings:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v1
|
|
- name: yaml-lint
|
|
uses: ibiqlik/action-yamllint@v3
|
|
```
|
|
|
|
Config data examples:
|
|
|
|
```yaml
|
|
# Single line
|
|
config_data: "{extends: default, rules: {new-line-at-end-of-file: disable}}"
|
|
```
|
|
|
|
``` yaml
|
|
# Multi line
|
|
config_data: |
|
|
extends: default
|
|
rules:
|
|
new-line-at-end-of-file:
|
|
level: warning
|
|
trailing-spaces:
|
|
level: warning
|
|
```
|
|
|
|
Use output to save/upload the log in artifact. Note, you must have `id` in the step running the yamllint action.
|
|
|
|
```yaml
|
|
---
|
|
name: Yaml Lint
|
|
on: [push] # yamllint disable-line rule:truthy
|
|
jobs:
|
|
lintAllTheThings:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v1
|
|
- id: yaml-lint
|
|
uses: ibiqlik/action-yamllint@v3
|
|
|
|
- run: echo ${{ steps.yaml-lint.outputs.logfile }}
|
|
|
|
- uses: actions/upload-artifact@v2
|
|
with:
|
|
name: yamllint-logfile
|
|
path: ${{ steps.yaml-lint.outputs.logfile }}
|
|
```
|