From 5802e0a5a804ef0261c02fbfdcb2bf7c9d7b600d Mon Sep 17 00:00:00 2001 From: Ilir Bekteshi Date: Sat, 14 Aug 2021 20:19:03 +0200 Subject: [PATCH] Make examples compliant #24 --- README.md | 43 +++++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 95fc90d..3c84f5c 100644 --- a/README.md +++ b/README.md @@ -34,32 +34,34 @@ Simple as: ### Example usage in workflow ```yaml +--- name: Yaml Lint -on: [push] +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 + - 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] +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 + - uses: actions/checkout@v1 + - name: yaml-lint + uses: ibiqlik/action-yamllint@v3 ``` 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. ```yaml +--- name: Yaml Lint -on: [push] +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 + - uses: actions/checkout@v1 + - id: yaml-lint + uses: ibiqlik/action-yamllint@v3 - - run: echo ${{ steps.yaml-lint.outputs.logfile }} + - run: echo ${{ steps.yaml-lint.outputs.logfile }} - - uses: actions/upload-artifact@v2 - with: - name: yamllint-logfile - path: ${{ steps.yaml-lint.outputs.logfile }} + - uses: actions/upload-artifact@v2 + with: + name: yamllint-logfile + path: ${{ steps.yaml-lint.outputs.logfile }} ```