Add yamllint, fix inconsistencies in yml files (#1558)

* Add yamllint, enable, basic relaxed config

adding a lint:yaml task to run yamllint,
and a default config ignoring node_modules/, extending the `relaxed` preset, and allowing longer line length

No-Issue

* workflows - fix yaml indent inconsistencies

    ./.github/workflows/i18n.yml
      8:13      warning  too many spaces after colon  (colons)
      22:5      warning  wrong indentation: expected 6 but found 4  (indentation)

    ./.github/workflows/pr-checks.yml
      32:5      warning  wrong indentation: expected 6 but found 4  (indentation)
      65:5      warning  wrong indentation: expected 6 but found 4  (indentation)

    ./.github/workflows/deploy-cloud.yml
      62:1      warning  too many blank lines (1 > 0)  (empty-lines)

    ./.github/workflows/cypress.yml
      12:13     warning  too many spaces after colon  (colons)
      27:5      warning  wrong indentation: expected 6 but found 4  (indentation)

* yamllint - use stricter rules without changes

yamllint default mode seems to require starting `---`, and +1 indent levels for arrays
balks on on:, spaces in arrays, and comments after one space, overriding those

    ./.yamllint
      1:1       warning  missing document start "---"  (document-start)

    ./.prettierrc.yaml
      1:1       warning  missing document start "---"  (document-start)

    ./.ls-lint.yml
      1:1       warning  missing document start "---"  (document-start)

    ./.github/dependabot.yml
      1:1       warning  missing document start "---"  (document-start)

    ./.github/ISSUE_TEMPLATE/config.yml
      2:1       warning  missing document start "---"  (document-start)
      4:1       error    wrong indentation: expected 2 but found 0  (indentation)

    ./.github/workflows/i18n.yml
      1:1       warning  missing document start "---"  (document-start)
      3:1       warning  truthy value should be one of [false, true]  (truthy)
      8:3       error    wrong indentation: expected 4 but found 2  (indentation)
      17:9      error    wrong indentation: expected 10 but found 8  (indentation)
      22:5      error    wrong indentation: expected 6 but found 4  (indentation)

    ./.github/workflows/pr-checks.yml
      1:1       warning  missing document start "---"  (document-start)
      3:1       warning  truthy value should be one of [false, true]  (truthy)
      5:16      error    too many spaces inside brackets  (brackets)
      5:37      error    too many spaces inside brackets  (brackets)
      13:5      error    wrong indentation: expected 6 but found 4  (indentation)
      32:5      error    wrong indentation: expected 6 but found 4  (indentation)
      65:5      error    wrong indentation: expected 6 but found 4  (indentation)

    ./.github/workflows/update-manifest.yml
      1:1       warning  missing document start "---"  (document-start)
      3:1       warning  truthy value should be one of [false, true]  (truthy)
      4:22      warning  too few spaces before comment  (comments)
      6:16      error    too many spaces inside brackets  (brackets)
      6:40      error    too many spaces inside brackets  (brackets)
      23:5      error    wrong indentation: expected 6 but found 4  (indentation)

    ./.github/workflows/deploy-cloud.yml
      1:1       warning  missing document start "---"  (document-start)
      3:1       warning  truthy value should be one of [false, true]  (truthy)
      4:22      warning  too few spaces before comment  (comments)
      6:16      error    too many spaces inside brackets  (brackets)
      6:70      error    too many spaces inside brackets  (brackets)
      28:5      error    wrong indentation: expected 6 but found 4  (indentation)

    ./.github/workflows/backported-labels.yml
      1:1       warning  missing document start "---"  (document-start)
      3:1       warning  truthy value should be one of [false, true]  (truthy)
      7:16      error    too many spaces inside brackets  (brackets)
      7:27      error    too many spaces inside brackets  (brackets)
      13:5      error    wrong indentation: expected 6 but found 4  (indentation)

    ./.github/workflows/dev-release.yml
      3:1       warning  missing document start "---"  (document-start)
      5:1       warning  truthy value should be one of [false, true]  (truthy)
      6:22      warning  too few spaces before comment  (comments)
      8:16      error    too many spaces inside brackets  (brackets)
      8:25      error    too many spaces inside brackets  (brackets)
      18:24     warning  too few spaces before comment  (comments)
      23:5      error    wrong indentation: expected 6 but found 4  (indentation)

    ./.github/workflows/stable-release.yml
      1:1       warning  missing document start "---"  (document-start)
      4:1       warning  truthy value should be one of [false, true]  (truthy)
      7:5       error    wrong indentation: expected 6 but found 4  (indentation)
      23:5      error    wrong indentation: expected 6 but found 4  (indentation)

    ./.github/workflows/cypress.yml
      1:1       warning  missing document start "---"  (document-start)
      3:1       warning  truthy value should be one of [false, true]  (truthy)
      7:16      error    too many spaces inside brackets  (brackets)
      7:37      error    too many spaces inside brackets  (brackets)
      9:16      error    too many spaces inside brackets  (brackets)
      9:37      error    too many spaces inside brackets  (brackets)
      12:3      error    wrong indentation: expected 4 but found 2  (indentation)
      27:5      error    wrong indentation: expected 6 but found 4  (indentation)

Author: himdel

.github/workflows/cypress.yml

@@ -9,7 +9,7 @@ on:
     branches: [ 'master', 'stable-*' ]
   # daily on master
   schedule:
-    - cron:  '30 5 * * *'
+  - cron: '30 5 * * *'
 
 concurrency:
   group: cypress-${{ github.ref }}

.github/workflows/deploy-cloud.yml

@@ -59,4 +59,3 @@ jobs:
         npm cache verify
         npm ci || npm install
         npm run deploy && curl -sSL https://raw.githubusercontent.com/RedHatInsights/insights-frontend-builder-common/master/src/bootstrap.sh | bash -s
-

.github/workflows/i18n.yml

@@ -5,7 +5,7 @@ on:
   workflow_dispatch:
   # run weekly
   schedule:
-    - cron:  '30 5 * * 0'
+  - cron: '30 5 * * 0'
 
 jobs:
   i18n:
@@ -14,8 +14,8 @@ jobs:
     strategy:
       matrix:
         branch:
-          - 'master'
-          - 'stable-4.4'
+        - 'master'
+        - 'stable-4.4'
 
     steps:
 

.github/workflows/pr-checks.yml

@@ -7,23 +7,23 @@ on:
 jobs:
 
   check_commit:
-
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-        with:
-          ref: ${{ github.event.after }}  # for PR avoids checking out merge commit
-          fetch-depth: 0  # include all history
 
-      - name: Run script to validate commits for both pull request and a push
-        env:
-          GITHUB_PR_COMMITS_URL: ${{ github.event.pull_request.commits_url }}
-          GITHUB_USER: ${{ github.event.pull_request.user.login }}
-          START_COMMIT: ${{ github.event.before }}
-          END_COMMIT: ${{ github.event.after }}
-        run: |
-          curl https://raw.githubusercontent.com/ansible/galaxy_ng/master/.ci/scripts/validate_commit_message_custom.py | python
+    - name: Checkout code
+      uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.after }}  # for PR avoids checking out merge commit
+        fetch-depth: 0  # include all history
+
+    - name: Run script to validate commits for both pull request and a push
+      env:
+        GITHUB_PR_COMMITS_URL: ${{ github.event.pull_request.commits_url }}
+        GITHUB_USER: ${{ github.event.pull_request.user.login }}
+        START_COMMIT: ${{ github.event.before }}
+        END_COMMIT: ${{ github.event.after }}
+      run: |
+        curl https://raw.githubusercontent.com/ansible/galaxy_ng/master/.ci/scripts/validate_commit_message_custom.py | python
 
   pr-checks:
     runs-on: ubuntu-latest
@@ -51,7 +51,7 @@ jobs:
         popd
 
         # dependencies
-        pip install lint-po
+        pip install lint-po yamllint
 
         # run linters
         npm run lint

.yamllint

@@ -0,0 +1,18 @@
+ignore: |
+  /node_modules/
+  /test/node_modules/
+
+extends: default
+
+rules:
+  line-length:
+    max: 240
+  indentation:
+    indent-sequences: consistent
+  brackets:
+    max-spaces-inside: 1
+  document-start: disable
+  truthy:
+    check-keys: false
+  comments:
+    min-spaces-from-content: 1

package.json

@@ -83,9 +83,10 @@
         "lint:js": "npm run prettier:check && npm run eslint",
         "lint:js:fix": "npm run eslint:fix && npm run prettier",
         "lint:ls": "ls-lint",
+        "lint:po": "lint-po locale/*.po",
         "lint:sass": "stylelint 'src/**/*.scss' --config .stylelintrc.json",
         "lint:ts": "tsc",
-        "lint:po": "lint-po locale/*.po",
+        "lint:yaml": "yamllint .",
         "prettier": "prettier --write 'src/**' 'config/**' 'test/**'",
         "prettier:check": "prettier -l 'src/**' 'config/**' 'test/**'",
         "prod": "NODE_ENV=production webpack serve --config custom.dev.config",