actions/yamllint
actions/yamllint
3
0
Fork 0
mirror of https://github.com/ibiqlik/action-yamllint.git synced 2024-11-23 18:19:33 +01:00
Code Issues Projects Activity Pipelines

Make examples compliant #24

Browse source
This commit is contained in:
Ilir Bekteshi 2021-08-14 20:19:03 +02:00
parent d5318587ea
commit 5802e0a5a8
1 changed files with 23 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -34,32 +34,34 @@ Simple as:
### Example usage in workflow ### Example usage in workflow
```yaml ```yaml
---
name: Yaml Lint name: Yaml Lint
on: [push] on: [push] # yamllint disable-line rule:truthy
jobs: jobs:
lintAllTheThings: lintAllTheThings:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v1 - uses: actions/checkout@v1
- name: yaml-lint - name: yaml-lint
uses: ibiqlik/action-yamllint@v3 uses: ibiqlik/action-yamllint@v3
with: with:
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: Or just simply check all yaml files in the repository:
```yaml ```yaml
---
name: Yaml Lint name: Yaml Lint
on: [push] on: [push] # yamllint disable-line rule:truthy
jobs: jobs:
lintAllTheThings: lintAllTheThings:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v1 - uses: actions/checkout@v1
- name: yaml-lint - name: yaml-lint
uses: ibiqlik/action-yamllint@v3 uses: ibiqlik/action-yamllint@v3
``` ```
Config data examples: Config data examples:
@ -83,20 +85,21 @@ config_data: |
Use output to save/upload the log in artifact. Note, you must have `id` in the step running the yamllint action. Use output to save/upload the log in artifact. Note, you must have `id` in the step running the yamllint action.
```yaml ```yaml
---
name: Yaml Lint name: Yaml Lint
on: [push] on: [push] # yamllint disable-line rule:truthy
jobs: jobs:
lintAllTheThings: lintAllTheThings:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v1 - uses: actions/checkout@v1
- id: yaml-lint - id: yaml-lint
uses: ibiqlik/action-yamllint@v3 uses: ibiqlik/action-yamllint@v3
- run: echo ${{ steps.yaml-lint.outputs.logfile }} - run: echo ${{ steps.yaml-lint.outputs.logfile }}
- uses: actions/upload-artifact@v2 - uses: actions/upload-artifact@v2
with: with:
name: yamllint-logfile name: yamllint-logfile
path: ${{ steps.yaml-lint.outputs.logfile }} path: ${{ steps.yaml-lint.outputs.logfile }}
``` ```