mirror of
https://github.com/ibiqlik/action-yamllint.git
synced 2024-11-24 15:21:04 -05:00
Use the current directory as default path for yamllint
Use the current directory as default path for yamllint. It's a handy default option which allows yamllint to check all yaml files in repository by default (which is usually the use case).
This commit is contained in:
parent
00803810a2
commit
cf0212bc66
2 changed files with 22 additions and 13 deletions
27
README.md
27
README.md
|
@ -4,18 +4,15 @@ This action executes `yamllint` (https://github.com/adrienverge/yamllint) agains
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Required parameters
|
|
||||||
|
|
||||||
- `file_or_dir` - Enter file/folder (space speparated), wildcards accepted. Examples:
|
|
||||||
- `file1.yaml`
|
|
||||||
- `file1.yaml file2.yaml`
|
|
||||||
- `.` - run against all yaml files in a directory recursively
|
|
||||||
- `kustomize/**/*.yaml mychart/*values.yaml`
|
|
||||||
|
|
||||||
### Optional parameters
|
### Optional parameters
|
||||||
|
|
||||||
- `config_file` - Path to custom configuration
|
- `config_file` - Path to custom configuration
|
||||||
- `config_data` - Custom configuration (as YAML source)
|
- `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]
|
- `format` - Format for parsing output [parsable,standard,colored,auto]
|
||||||
- `strict` - Return non-zero exit code on warnings as well as errors [true,false]
|
- `strict` - Return non-zero exit code on warnings as well as errors [true,false]
|
||||||
|
|
||||||
|
@ -35,3 +32,17 @@ jobs:
|
||||||
file_or_dir: myfolder/*values*.yaml
|
file_or_dir: myfolder/*values*.yaml
|
||||||
config_file: .yamllint.yml
|
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@master
|
||||||
|
- name: yaml-lint
|
||||||
|
uses: ibiqlik/action-yamllint@master
|
||||||
|
```
|
||||||
|
|
|
@ -4,10 +4,8 @@ echo "======================"
|
||||||
echo "= Linting YAML files ="
|
echo "= Linting YAML files ="
|
||||||
echo "======================"
|
echo "======================"
|
||||||
|
|
||||||
if [ -z "INPUT_FILE_OR_DIR" ]; then
|
# Use the current directory by default
|
||||||
echo "file_or_dir not provided, add it in workflow"
|
export INPUT_FILE_OR_DIR=${INPUT_FILE_OR_DIR:-.}
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
STRICT=""
|
STRICT=""
|
||||||
if [ "$INPUT_STRICT" == "true" ]; then
|
if [ "$INPUT_STRICT" == "true" ]; then
|
||||||
|
@ -22,4 +20,4 @@ if [ ! -z "$INPUT_CONFIG_DATA" ]; then
|
||||||
CONFIG_DATA="-d $INPUT_CONFIG_DATA"
|
CONFIG_DATA="-d $INPUT_CONFIG_DATA"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
yamllint $CONFIG_FILE $CONFIG_DATA -f $INPUT_FORMAT $STRICT $INPUT_FILE_OR_DIR
|
yamllint $CONFIG_FILE $CONFIG_DATA -f $INPUT_FORMAT $STRICT $INPUT_FILE_OR_DIR
|
||||||
|
|
Loading…
Reference in a new issue