Merge pull request #1490 from cernymi/cernymi/yamllint

add yamllint to project pipeline and fix errors

Author: sc68cal

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -67,7 +67,7 @@ body:
         Describe in detail the exact steps that someone else can take to
         reproduce this bug using the current stable release of the Ansible NetBox collection.
         Include any sanatized playbooks, variables, & tasks specifically showing just the issue.
-      #placeholder: |
+      # placeholder: |
 
     validations:
       required: true

.github/workflows/main.yml

@@ -15,6 +15,13 @@ jobs:
       - name: Run black
         uses: psf/black@stable
 
+      - name: Run yamllint
+        uses: ibiqlik/action-yamllint@v3
+        with:
+          file_or_dir: .
+          config_file: .yamllint.yml
+          strict: true
+
   unit_testing:
     runs-on: ubuntu-24.04
     needs: linting
@@ -66,7 +73,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        include:                              
+        include:
           - VERSION: "v4.1"
             NETBOX_DOCKER_VERSION: 3.0.1
           - VERSION: "v4.2"
@@ -114,7 +121,7 @@ jobs:
           docker container ls
           docker logs netbox-docker-netbox-1
           timeout 300 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:32768/login/)" != "200" ]]; do echo "waiting for NetBox"; sleep 5; done' || false
-        working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox        
+        working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
 
       - name: Pre-populate NetBox
         run: ./tests/integration/netbox-deploy.py
@@ -126,13 +133,13 @@ jobs:
           ansible-test integration -v --color --coverage --python ${{ env.python-version }} inventory-${{ matrix.VERSION }}
         working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
 
-      - name: Run regression tests        
+      - name: Run regression tests
         continue-on-error: true
-        run: |          
-          ansible-test integration -v --color --coverage --python ${{ env.python-version }} regression-${{ matrix.VERSION }}          
+        run: |
+          ansible-test integration -v --color --coverage --python ${{ env.python-version }} regression-${{ matrix.VERSION }}
         working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
 
-      - name: Run integration tests        
+      - name: Run integration tests
         run: |
           ansible-test integration -v --color --coverage --python ${{ env.python-version }} ${{ matrix.VERSION }}
           ansible-test coverage report --all --omit "tests/*,hacking/*,docs/*" --show-missing

.github/workflows/tests.yml

@@ -47,4 +47,4 @@ jobs:
           '${{ needs.unit-galaxy.result }}',
           '${{ needs.unit-source.result }}',
           '${{ needs.ansible-lint.result }}'
-          ])"
+          ])"

.yamllint.yml

@@ -0,0 +1,52 @@
+---
+extends: default
+
+# see rules at https://yamllint.readthedocs.io/en/latest/rules.html
+ignore: |
+  - .cache/
+  - .venv/
+  - .github/
+
+rules:
+  braces:
+    max-spaces-inside: 20
+    level: error
+  brackets:
+    max-spaces-inside: 20
+    level: error
+  colons:
+    max-spaces-before: 1
+    max-spaces-after: 20
+    level: error
+  commas:
+    max-spaces-before: 50
+    min-spaces-after: 1
+    max-spaces-after: 20
+    level: error
+  comments:
+    min-spaces-from-content: 1
+  comments-indentation: disable
+  document-start:
+    present: true
+  empty-lines:
+    max: 3
+    level: error
+  hyphens:
+    level: error
+  indentation:
+    spaces: 2
+    indent-sequences: whatever
+    check-multi-line-strings: false
+  key-duplicates: enable
+  line-length:
+    max: 230
+    level: warning
+    allow-non-breakable-words: true
+    allow-non-breakable-inline-mappings: true
+  new-line-at-end-of-file: enable
+  new-lines:
+    type: unix
+  trailing-spaces: enable
+  truthy: disable
+  octal-values:
+    forbid-explicit-octal: true

changelogs/changelog.yaml

@@ -1,3 +1,4 @@
+---
 ancestor: null
 releases:
   0.1.0:

changelogs/fragments/1182-fix-contact-groups.yml

@@ -1,3 +1,4 @@
+---
 minor_changes:
   - Change `netbox_contact.contact_group` to `contact_groups`
   - Add integration tests for contact groups

changelogs/fragments/1433-add-custom-headers.yml

@@ -1,2 +1,3 @@
+---
 minor_changes:
   - Add support for custom headers for all modules

changelogs/fragments/1435-fix-duplicate-task-name.yml

@@ -1,2 +1,3 @@
+---
 bugfixes:
   - Fix task duplicate task name in documentation that cause ansible-lint error

changelogs/fragments/1438-fix-inventory-service-collection.yml

@@ -1,2 +1,3 @@
+---
 bugfixes:
   - nb_inventory - Fix service collection for version greater than 4.3

changelogs/fragments/1439-fix-sevral-bug-discovered-by-integration-tests.yml

@@ -1,3 +1,4 @@
+---
 bugfixes:
   - Add netbox version check to support service creation for netbox version prior of 4.3
   - Use dedicated function to check netbox version istead of self.full_version for rack.