Merge pull request #127 from xmidt-org/add-yml-checking

Add yaml linting support to automatically be performed.

.github/dependabot.yml

@@ -1,5 +1,6 @@
 # SPDX-FileCopyrightText: 2023 Comcast Cable Communications Management, LLC
 # SPDX-License-Identifier: Apache-2.0
+---
 
 version: 2
 updates:

.github/workflows/auto-release.yml

@@ -1,13 +1,13 @@
 # SPDX-FileCopyrightText: 2024 Comcast Cable Communications Management, LLC
 # SPDX-License-Identifier: Apache-2.0
 ---
-    name: 'Automatically relase patch versions.'
-    
-    on:
-      schedule: # Run every day at 12:00 UTC
-        - cron: '0 12 * * *'
-      workflow_dispatch:
-    
-    jobs:
-      release:
-        uses: ./.github/workflows/auto-releaser.yml
+name: 'Automatically relase patch versions.'
+
+on:
+  schedule: # Run every day at 12:00 UTC
+    - cron: '0 12 * * *'
+  workflow_dispatch:
+
+jobs:
+  release:
+    uses: ./.github/workflows/auto-releaser.yml

.github/workflows/auto-releaser.yml

@@ -5,12 +5,12 @@
 ## SPDX-License-Identifier: Apache-2.0
 #---
 #name: 'Automatically relase patch versions.'
-#  
+#
 #  on:
 #    schedule: # Run every day at 12:00 UTC
 #      - cron: '0 12 * * *'
 #    workflow_dispatch:
-#  
+#
 #  jobs:
 #    release:
 #      uses: xmidt-org/shared-go/.github/workflows/ci.yml@826aa545bb56f6c7c551d44febb420c0293c8bff # v4.2.0

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022-2023 Comcast Cable Communications Management, LLC
+# SPDX-FileCopyrightText: 2022-2024 Comcast Cable Communications Management, LLC
 # SPDX-FileCopyrightText: 2022 Weston Schmidt <weston_schmidt@alumni.purdue.edu>
 # SPDX-License-Identifier: Apache-2.0
 # Copied from github.com/goschtalt/.github
@@ -50,7 +50,9 @@ on:
         type: boolean
         default: true
       go-generate-deps:
-        description: "The line sparated list of go generate dependencies to install via `go install` prior to running `go generate`."
+        description: |
+          The line sparated list of go generate dependencies to install via
+          `go install` prior to running `go generate`.
         required: false
         type: string
         default: ''
@@ -143,12 +145,16 @@ on:
         default: false
 
       release-docker-extras:
-        description: "Provides a way to set the `extra_files` field with the list of files/dirs to make available."
+        description: |
+          Provides a way to set the `extra_files` field with the list of
+          files/dirs to make available.
         required: false
         type: string
 
       release-docker-file:
-        description: "Set to the docker file and path if you don't want the default of `Dockerfile` in the project root."
+        description: |
+          Set to the docker file and path if you don't want the default of
+          `Dockerfile` in the project root.
         required: false
         type: string
         default: 'Dockerfile'
@@ -160,7 +166,9 @@ on:
         default: false
 
       release-docker-major:
-        description: "If set to true, release this container as the latest for the major version."
+        description: |
+          If set to true, release this container as the latest for
+          the major version.
         required: false
         type: boolean
         default: false
@@ -189,6 +197,12 @@ on:
         type: boolean
         default: true
 
+      release-skip:
+        description: 'Skip releasing the program.'
+        required: false
+        type: boolean
+        default: false
+
       release-skip-publish:
         description: "Set to --skip-publish to skip publishing."
         required: false
@@ -201,13 +215,17 @@ on:
         type: string
 
       release-with-extra-contents:
-        description: "The list of any extra files to include in the packaged releases.  See goreleaser nfpm contents for examples."
+        description: |
+          The list of any extra files to include in the packaged releases.  See
+          goreleaser nfpm contents for examples.
         required: false
         type: string
         default: ''
 
       release-with-unique-user:
-        description: "If set to true will add a user and group with the same name as the program.  Otherwise root is assumed."
+        description: |
+          If set to true will add a user and group with the same name as the
+          program.  Otherwise root is assumed.
         required: false
         type: string
         default: "true"
@@ -231,7 +249,9 @@ on:
 
       # Unit test focused
       tests-race:
-        description: 'If set to "true" (default), race condition checking will be performed during unit tests.  Otherwise no race condition checking will be done.'
+        description: |
+          If set to "true" (default), race condition checking will be performed
+          during unit tests.  Otherwise no race condition checking will be done.
         required: false
         type: boolean
         default: true
@@ -241,12 +261,20 @@ on:
         type: boolean
         default: false
 
+      # Artifact uploading focused
       upload-skip:
         description: 'Skip uploading the artifacts.'
         required: false
         type: boolean
         default: false
 
+      # YML linting focused
+      yaml-lint-skip:
+        description: 'Skip linting yaml files.'
+        required: false
+        type: boolean
+        default: false
+
 jobs:
 
 
@@ -426,7 +454,6 @@ jobs:
           retention-days: 10
 
 
-
   golint:
     runs-on: [ ubuntu-latest ]
     name: Go Lint
@@ -467,14 +494,21 @@ jobs:
           version: ${{ inputs.lint-version }}
           working-directory: ${{ inputs.working-directory }}
           args: --timeout ${{ inputs.lint-timeout }}
-          skip-pkg-cache: true
-          skip-build-cache: true
+          skip-cache: true
+
+  ymllint:
+    runs-on: [ ubuntu-latest ]
+    if: inputs.yaml-lint-skip == false
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
 
+      - uses: ibiqlik/action-yamllint@2576378a8e339169678f9939646ee3ee325e845c # v3.1.1
 
   copyright:
     runs-on: [ ubuntu-latest ]
     if: inputs.copyright-skip == false
-    steps: 
+    steps:
       - name: Checkout the code
         uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
 
@@ -506,8 +540,8 @@ jobs:
       - name: Setup licensed
         uses: jonabc/setup-licensed@d6b3a6f7058c2b40c06d205e13e15c2418977566 # v1.1.4
         with:
-         version: 4.x
-         github_token: ${{ secrets.GITHUB_TOKEN }}
+          version: 4.x
+          github_token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Fetch Org Approved Licenses & merge to local
         shell: bash
@@ -562,7 +596,7 @@ jobs:
       packages: write
 
     name: Release
-    needs: [ build_program, unit_test, style, golint, license, copyright ]
+    needs: [ build_program, unit_test, style, golint, license, copyright, ymllint ]
     if: |
       always() &&
       inputs.release-skip        == false     &&
@@ -571,6 +605,7 @@ jobs:
       needs.unit_test.result     != 'failure' &&
       needs.style.result         != 'failure' &&
       needs.golint.result        != 'failure' &&
+      needs.ymllint.result       != 'failure' &&
       needs.copyright.result     != 'failure' &&
       needs.license.result       != 'failure'
     runs-on: [ ubuntu-latest ]
@@ -852,7 +887,7 @@ jobs:
           if [[ "${{ inputs.license }}" != "" ]]; then
             echo "LICENSE='${{ inputs.license }}'" >> $GITHUB_ENV
           fi
-        
+
       - name: Generate the rpm generation section
         if: |
           inputs.release-custom-file == false     &&

.github/workflows/cleanup-tags.yml

@@ -1,29 +1,29 @@
 # SPDX-FileCopyrightText: 2024 Comcast Cable Communications Management, LLC
 # SPDX-License-Identifier: Apache-2.0
 ---
-    name: 'Cleanup testing tags.'
-    
-    on:
-      schedule:
-        - cron: '52 1 * * 1'  # Monday at 1:52am UTC clean everything up
-      workflow_dispatch:
-    
-    jobs:
-      remove-tags:
-        runs-on: [ ubuntu-latest ]
-        steps:
-          - name: Checkout the code
-            uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
-            with:
-              fetch-depth: 0
-              token: ${{ secrets.PUSH_TAG_TOKEN }}
-    
-          - name: Search for v1.x.x or v2.x.x tags to remove
-            shell: bash
-            run: |
-              mapfile -t tags< <(git tag | grep "v[12]\.")
-              for tag in "${tags[@]}"; do
-                echo "Removing $tag"
-                git tag -d $tag
-                git push origin :refs/tags/$tag
-              done
+name: 'Cleanup testing tags.'
+
+on:
+  schedule:
+    - cron: '52 1 * * 1'  # Monday at 1:52am UTC clean everything up
+  workflow_dispatch:
+
+jobs:
+  remove-tags:
+    runs-on: [ ubuntu-latest ]
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.PUSH_TAG_TOKEN }}
+
+      - name: Search for v1.x.x or v2.x.x tags to remove
+        shell: bash
+        run: |
+          mapfile -t tags< <(git tag | grep "v[12]\.")
+          for tag in "${tags[@]}"; do
+            echo "Removing $tag"
+            git tag -d $tag
+            git push origin :refs/tags/$tag
+          done

.github/workflows/tests.yml

@@ -163,7 +163,7 @@ jobs:
     secrets: inherit
 
   tag:
-    needs: 
+    needs:
       - command
       - program
       - library

.yamllint.yml

@@ -0,0 +1,33 @@
+# SPDX-FileCopyrightText: 2024 Comcast Cable Communications Management, LLC
+# SPDX-License-Identifier: Apache-2.0
+---
+
+extends: default
+
+rules:
+  braces:
+    level: warning
+    max-spaces-inside: 1
+  brackets:
+    level: warning
+    max-spaces-inside: 1
+  colons:
+    level: warning
+    max-spaces-after: -1
+  commas:
+    level: warning
+  comments: disable
+  comments-indentation: disable
+  document-start: disable
+  empty-lines:
+    level: warning
+  hyphens:
+    level: warning
+  indentation:
+    level: error
+    indent-sequences: consistent
+  line-length:
+    level: warning
+    max: 110
+    allow-non-breakable-inline-mappings: true
+  truthy: disable