Merge pull request #2578 from 89luca89/main

ci: add job to detect PRs that need docs update

Author: FabianKramm

.github/workflows/check-docs.yaml

@@ -0,0 +1,45 @@
+name: Check Docs
+
+on:
+  pull_request:
+
+jobs:
+
+  check_changes:
+    runs-on: ubuntu-latest
+    outputs:
+      docs_changes: ${{ steps.check_file_changed.outputs.changed }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          # Checkout as many commits as needed for the diff
+          fetch-depth: 2
+
+      # Generate docs
+      # Return true/false if docs are changed
+      - id: check_file_changed
+        run: |
+          ./gendocs.sh
+          if git diff --name-only | grep -E "^docs|devspace-schema.json"; then
+            echo "{changed}={True}" >> $GITHUB_OUTPUT
+          else
+            echo "{changed}={False}" >> $GITHUB_OUTPUT
+          fi
+
+
+
+  check-docs:
+    runs-on: ubuntu-latest
+    needs: check_changes
+    if: needs.check_changes.outputs.docs_changes == 'True'
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: mshick/add-pr-comment@v2
+        with:
+          allow-repeats: true
+          message: |
+            **Docs Update Needed!**
+            It seems like you need to run `gendocs.sh` in order to update the docs.
+            Please run this command and commit before merging.
+            Thanks!

gendocs.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+set -o errexit
+set -o nounset
+
+go run ./docs/hack/cli/main.go
+go run ./docs/hack/config/partials/main.go
+go run ./docs/hack/config/schemas/main.go