From a65cf639f438af695f3081b0436ed86bba632a65 Mon Sep 17 00:00:00 2001 From: Jacob Valdez Date: Thu, 4 Dec 2025 09:28:23 -0600 Subject: [PATCH] Adds workflow that comments on PRs that change defaults.ini with docs reminder (#114739) --- .github/CODEOWNERS | 1 + .../workflows/defaults-ini-docs-reminder.yml | 24 +++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 .github/workflows/defaults-ini-docs-reminder.yml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 59025d0b7cb..30bba5db0ff 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1305,6 +1305,7 @@ embed.go @grafana/grafana-as-code /.github/actionlint.yaml @grafana/grafana-developer-enablement-squad /.github/workflows/pr-test-docker.yml @grafana/grafana-developer-enablement-squad /.github/workflows/update-schema-types.yml @grafana/plugins-platform-frontend +/.github/workflows/defaults-ini-docs-reminder.yml @grafana/docs-tooling @jtvdez # Generated files not requiring owner approval /packages/grafana-data/src/types/featureToggles.gen.ts @grafanabot diff --git a/.github/workflows/defaults-ini-docs-reminder.yml b/.github/workflows/defaults-ini-docs-reminder.yml new file mode 100644 index 00000000000..98104c914b0 --- /dev/null +++ b/.github/workflows/defaults-ini-docs-reminder.yml @@ -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.