From 1f224ad765fa71e3e538a0f7225d7c58d0d41f88 Mon Sep 17 00:00:00 2001
From: Johannes Lorenz <1042576+JohannesLorenz@users.noreply.github.com>
Date: Sun, 4 Aug 2024 15:47:43 +0200
Subject: [PATCH] Add yamllint checks (#7424)

---
 .github/FUNDING.yml                        | 1 +
 .github/ISSUE_TEMPLATE/bug_report.yml      | 3 ++-
 .github/ISSUE_TEMPLATE/config.yml          | 7 ++++---
 .github/ISSUE_TEMPLATE/feature_request.yml | 3 ++-
 .github/no-response.yml                    | 1 +
 .github/workflows/build.yml                | 2 ++
 .github/workflows/checks.yml               | 7 +++++++
 .yamllint                                  | 3 +++
 8 files changed, 22 insertions(+), 5 deletions(-)
 create mode 100644 .yamllint

diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
index 8a8b03635..702d581fe 100644
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
@@ -1 +1,2 @@
+---
 custom: https://lmms.io/get-involved/#donate
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 4cd1464d6..fe3d60ff2 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -78,7 +78,8 @@ body:
       label: Screenshots / Minimum Reproducible Project
       description: |
         - Upload any screenshots showing the bug in action.
-        - If possible, also include a .mmp/.mmpz project containing the simplest possible setup needed to reproduce the bug.
+        - If possible, also include a .mmp/.mmpz project containing the simplest possible
+          setup needed to reproduce the bug.
 
         ***Note:** To upload a project file to GitHub, it will need to be placed in a .zip archive.*
   - type: checkboxes
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 2c51f276e..735942ffb 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,4 +1,5 @@
+---
 contact_links:
-- name: Get help on Discord
-  url: https://lmms.io/chat/
-  about: Need help? Have a question? Reach out to other LMMS users on our Discord server!
+  - name: Get help on Discord
+    url: https://lmms.io/chat/
+    about: Need help? Have a question? Reach out to other LMMS users on our Discord server!
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
index 1f11b4eb3..cc233a636 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -10,7 +10,8 @@ body:
       label: Enhancement Summary
       description: |
         - Briefly describe the enhancement.
-        - Explain why you believe the proposed enhancement to be a good idea, and (if applicable) how it helps overcome a limitation of LMMS you are currently facing.
+        - Explain why you believe the proposed enhancement to be a good idea, and (if applicable) how it helps
+          overcome a limitation of LMMS you are currently facing.
     validations:
       required: true
   - type: textarea
diff --git a/.github/no-response.yml b/.github/no-response.yml
index 476165408..f6c329539 100644
--- a/.github/no-response.yml
+++ b/.github/no-response.yml
@@ -1,2 +1,3 @@
+---
 # Label requiring a response
 responseRequiredLabel: "response required"
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 14c617b65..2c2e8dd73 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -260,12 +260,14 @@ jobs:
       - name: Cache ccache data
         uses: actions/cache@v3
         with:
+          # yamllint disable rule:line-length
           key: "ccache-${{ github.job }}-${{ matrix.arch }}-${{ github.ref }}\
             -${{ github.run_id }}"
           restore-keys: |
             ccache-${{ github.job }}-${{ matrix.arch }}-${{ github.ref }}-
             ccache-${{ github.job }}-${{ matrix.arch }}-
           path: ~\AppData\Local\ccache
+          # yamllint enable rule:line-length
       - name: Install tools
         run: choco install ccache
       - name: Install Qt
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
index 3f7700674..228f383c1 100644
--- a/.github/workflows/checks.yml
+++ b/.github/workflows/checks.yml
@@ -31,3 +31,10 @@ jobs:
             $(find "./cmake/" -type f -name '*.sh' -o -name "*.sh.in") \
             doc/bash-completion/lmms \
             buildtools/update_locales
+  yamllint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v3
+      - name: Run yamllint
+        run: for i in $(git ls-files '*.yml'); do yamllint $i; done
diff --git a/.yamllint b/.yamllint
new file mode 100644
index 000000000..a7aa0ae1e
--- /dev/null
+++ b/.yamllint
@@ -0,0 +1,3 @@
+rules:
+  line-length:
+    max: 120  # be conforming to LMMS coding rules