From 74736c08a3c44b2b94607d929b669c54efa02c8c Mon Sep 17 00:00:00 2001
From: Felix Fontein <felix@fontein.de>
Date: Mon, 13 May 2024 20:18:07 +0200
Subject: [PATCH] Add linting workflow with yamllint; fix linting issues (#396)

* Add linting workflow with yamllint. Fix linting issues.

* Use nox for running yamllint.
---
 .github/dependabot.yml                |  2 +-
 .github/workflows/ansible-release.yml | 45 +++++++++++++------------
 .github/workflows/antsibull-build.yml |  7 +++-
 .github/workflows/nox.yml             | 47 +++++++++++++++++++++++++++
 .yamllint                             | 15 +++++++++
 10/collection-meta.yaml               |  2 +-
 8/collection-meta.yaml                |  2 +-
 9/collection-meta.yaml                |  2 +-
 README.md                             |  4 +++
 noxfile.py                            | 10 ++++++
 10 files changed, 110 insertions(+), 26 deletions(-)
 create mode 100644 .github/workflows/nox.yml
 create mode 100644 .yamllint

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
index 2f4ff900d8..f0e426e155 100644
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
@@ -1,6 +1,6 @@
 ---
 # Copyright (c) Ansible Project
-# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 version: 2
diff --git a/.github/workflows/ansible-release.yml b/.github/workflows/ansible-release.yml
index 172bde4ecf..a7c816454a 100644
--- a/.github/workflows/ansible-release.yml
+++ b/.github/workflows/ansible-release.yml
@@ -1,5 +1,10 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 name: Release Ansible package
-on:
+'on':
   workflow_dispatch:
     inputs:
       ansible-version:
@@ -142,26 +147,25 @@ jobs:
       id-token: write
 
     steps:
+      - name: Ensure that the PR was merged
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_URL: ${{ needs.build.outputs.pr_url }}
+        run: |
+          STATE="$(gh pr view "${PR_URL}" --json state --template "{{.state}}")"
+          if [ "${STATE}" != "MERGED" ]; then
+            echo "::error ::The state of PR ${PR_URL} must be MERGED, not ${STATE}"
+            exit 1
+          fi
+
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: sdist-and-wheel
+          path: dist/
 
-    - name: Ensure that the PR was merged
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        PR_URL: ${{ needs.build.outputs.pr_url }}
-      run: |
-        STATE="$(gh pr view "${PR_URL}" --json state --template "{{.state}}")"
-        if [ "${STATE}" != "MERGED" ]; then
-          echo "::error ::The state of PR ${PR_URL} must be MERGED, not ${STATE}"
-          exit 1
-        fi
-
-    - name: Download artifact
-      uses: actions/download-artifact@v4
-      with:
-        name: sdist-and-wheel
-        path: dist/
-
-    - name: Upload Ansible sdist and wheel to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Upload Ansible sdist and wheel to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
 
   # git-tag job creates the git tag
 
@@ -174,7 +178,6 @@ jobs:
       contents: write
 
     steps:
-
       - name: Check out ansible-build-data
         uses: actions/checkout@v4
         with:
diff --git a/.github/workflows/antsibull-build.yml b/.github/workflows/antsibull-build.yml
index 13d011a2ab..2d635c6c7b 100644
--- a/.github/workflows/antsibull-build.yml
+++ b/.github/workflows/antsibull-build.yml
@@ -1,5 +1,10 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 name: antsibull-build
-on:
+'on':
   push:
     branches: [main]
   pull_request:
diff --git a/.github/workflows/nox.yml b/.github/workflows/nox.yml
new file mode 100644
index 0000000000..a6ac83ec79
--- /dev/null
+++ b/.github/workflows/nox.yml
@@ -0,0 +1,47 @@
+---
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2023 Maxwell G <maxwell@gtmx.me
+
+name: nox
+'on':
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  # Run once per week (Thursday at 04:00 UTC)
+  schedule:
+    - cron: '0 4 * * 4'
+  workflow_dispatch:
+
+env:
+  FORCE_COLOR: "1"
+
+jobs:
+  nox:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: antsibull
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - session: lint
+            python-versions: "3.12"
+    name: "Run nox ${{ matrix.session }} session"
+    steps:
+      - name: Check out antsibull
+        uses: actions/checkout@v4
+        with:
+          path: antsibull
+      - name: Setup nox
+        uses: wntrblm/nox@2024.04.15
+        with:
+          python-versions: "${{ matrix.python-versions }}"
+      - name: Set up nox environments
+        run: |
+          OTHER_ANTSIBULL_MODE=git nox -v -e "${{ matrix.session }}" ${{ matrix.codecov && 'coverage' || '' }} --install-only
+      - name: "Run nox -e ${{ matrix.session }}"
+        run: |
+          OTHER_ANTSIBULL_MODE=git nox -v -e "${{ matrix.session }}" --reuse-existing-virtualenvs --no-install
diff --git a/.yamllint b/.yamllint
new file mode 100644
index 0000000000..eb5203ad2a
--- /dev/null
+++ b/.yamllint
@@ -0,0 +1,15 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+extends: default
+
+rules:
+  line-length: disable
+
+ignore:
+  - /.nox/
+  - /*/ansible-*.yaml
+  - /*/changelog.yaml
+  - /*/galaxy-requirements.yaml
diff --git a/10/collection-meta.yaml b/10/collection-meta.yaml
index 4e1c98bcb7..28a4f57c50 100644
--- a/10/collection-meta.yaml
+++ b/10/collection-meta.yaml
@@ -113,7 +113,7 @@ collections:
       - alinabuzachis
       - GomathiselviS
       - abikouo
-      - komaldesai13 
+      - komaldesai13
     repository: https://github.com/ansible-collections/vmware.vmware_rest
   cisco.dnac:
     maintainers:
diff --git a/8/collection-meta.yaml b/8/collection-meta.yaml
index af343c05f9..04fa405028 100644
--- a/8/collection-meta.yaml
+++ b/8/collection-meta.yaml
@@ -133,7 +133,7 @@ collections:
       - alinabuzachis
       - GomathiselviS
       - abikouo
-      - komaldesai13 
+      - komaldesai13
     repository: https://github.com/ansible-collections/vmware.vmware_rest
   cisco.dnac:
     maintainers:
diff --git a/9/collection-meta.yaml b/9/collection-meta.yaml
index bae582fdd6..7fc9052628 100644
--- a/9/collection-meta.yaml
+++ b/9/collection-meta.yaml
@@ -137,7 +137,7 @@ collections:
       - alinabuzachis
       - GomathiselviS
       - abikouo
-      - komaldesai13 
+      - komaldesai13
     repository: https://github.com/ansible-collections/vmware.vmware_rest
   cisco.dnac:
     maintainers:
diff --git a/README.md b/README.md
index 72c4ed33d4..1ffc17ebdb 100644
--- a/README.md
+++ b/README.md
@@ -77,6 +77,10 @@ In case of a potential release blocker, the following actions need to be done:
   release of Ansible.  This file will be created by the `antsibull-build single`
   command.
 
+## Linting
+
+To lint the files in this repository, run `nox -e lint`. This assumes you have `nox` installed.
+
 ## Adding a new collection
 
 ### Next Ansible major release
diff --git a/noxfile.py b/noxfile.py
index 6d724905b6..e37e8d3fce 100644
--- a/noxfile.py
+++ b/noxfile.py
@@ -1,3 +1,7 @@
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2023 Maxwell G <maxwell@gtmx.me
+
 from __future__ import annotations
 
 import nox
@@ -7,3 +11,9 @@
 def mkdocs(session: nox.Session):
     session.install("-r", "docs-requirements.txt")
     session.run("mkdocs", *(session.posargs or ["build"]))
+
+
+@nox.session
+def lint(session: nox.Session):
+    session.install("yamllint")
+    session.run("yamllint", ".")