mirror of
https://github.com/ibiqlik/action-yamllint.git
synced 2024-11-25 15:50:55 -05:00
1685dea1ac
Add wf to autotag minor and patch releases By default use Dockerfile rather than docker image, obviously is slower by ~15 sec which consumes precious runner minutes but harder to automate releases, tagging and updating image reference in action.yaml thou not impossible. Next time.
48 lines
1.2 KiB
Markdown
48 lines
1.2 KiB
Markdown
# GitHub YAMLlint
|
|
|
|
This action executes `yamllint` (https://github.com/adrienverge/yamllint) against file(s) or folder
|
|
|
|
## Usage
|
|
|
|
### Optional 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,auto] (default: colored)
|
|
- `strict` - Return non-zero exit code on warnings as well as errors [true,false]
|
|
|
|
### Example usage in workflow
|
|
|
|
```yaml
|
|
name: Yaml Lint
|
|
on: [push]
|
|
jobs:
|
|
lintAllTheThings:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
- name: yaml-lint
|
|
uses: ibiqlik/action-yamllint@v1
|
|
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]
|
|
jobs:
|
|
lintAllTheThings:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v1
|
|
- name: yaml-lint
|
|
uses: ibiqlik/action-yamllint@master
|
|
```
|