From e59fc2ffec83e694bc3c8989c3906dcab5a0a11d Mon Sep 17 00:00:00 2001
From: Nick Andreano <nick.andreano@itential.com>
Date: Wed, 5 Aug 2026 16:15:55 -0400
Subject: [PATCH] added readme check

---
 .github/workflows/role-readme-check.yml | 27 +++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 .github/workflows/role-readme-check.yml

diff --git a/.github/workflows/role-readme-check.yml b/.github/workflows/role-readme-check.yml
new file mode 100644
index 0000000..ee11beb
--- /dev/null
+++ b/.github/workflows/role-readme-check.yml
@@ -0,0 +1,27 @@
+# .github/workflows/role-readme-check.yml
+#
+# Ansible Galaxy requires every role to have its own README. This job fails the build
+# (blocking merge to main) if any directory under roles/ is missing one.
+name: role-readme-check
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+jobs:
+  check-role-readmes:
+    name: Role READMEs # Naming the build is important to use it as a status check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Verify every role has a README
+        run: |
+          missing=0
+          for dir in roles/*/; do
+            role=$(basename "$dir")
+            if ! ls "$dir" 2>/dev/null | grep -qi '^readme'; then
+              echo "::error::Role '$role' is missing a README (required by Ansible Galaxy)"
+              missing=1
+            fi
+          done
+          exit "$missing"