Adds workflow that comments on PRs that change defaults.ini with docs reminder (#114739)

2025-12-04 09:28:23 -06:00
parent 32a58c56ed
commit a65cf639f4
2 changed files with 25 additions and 0 deletions
@@ -0,0 +1,24 @@
+name: Remind about config documentation updates
+on:
+  pull_request:
+    types: [opened]
+    paths:
+      - 'conf/defaults.ini'
+
+jobs:
+  add-comment:
+    if: ${{ ! github.event.pull_request.head.repo.fork }}
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4
+        with:
+          message: |
+            Hi there! 👋 This PR modifies `conf/defaults.ini`.
+            
+            If this change introduces user-facing configuration options or modifies existing ones, please remember to update [`docs/sources/setup-grafana/configure-grafana/_index.md`](https://github.com/grafana/grafana/blob/main/docs/sources/setup-grafana/configure-grafana/_index.md).
+            
+            If this change is internal-only (experimental flags, internal refactoring, etc.), you can ignore this reminder.
+            
+            Questions? Reach out to the #docs channel on Slack.