chore: Check for readme changes in each PR (#11495)

.circleci/config.yml

@@ -180,6 +180,7 @@ jobs:
       - restore_cache:
           key: go-mod-v1-{{ checksum "go.sum" }}
       - check-changed-files-or-halt
+      - run: ./scripts/make_docs.sh
       - run: 'make deps'
       - run: 'make tidy'
       - run: 'make check'

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,13 @@
-### Required for all PRs:
+# Required for all PRs
+
+<!-- Before opening a pull request you should run the following checks to make sure the CI will pass.
+
+make check
+make check-deps
+make test
+make docs
+
+-->
 
 <!-- Complete the tasks in the following list. Change [ ] to [x] to
 show completion. -->

CONTRIBUTING.md

@@ -68,12 +68,13 @@ Telegraf uses Go modules. Assuming you can already build the project, run this i
 
 **Unit Tests:**
 
-Before opening a pull request you should run the linter checks and
-the short tests.
+Before opening a pull request you should run the following checks to make sure the CI will pass.
 
 ```shell
 make check
+make check-deps
 make test
+make docs
 ```
 
 **Execute integration tests:**

scripts/make_docs.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+make docs
+
+if [ "$(git status --porcelain | wc -l)" -eq "0" ]; then
+  echo "🟢 Git repo is clean."
+else
+  echo "🔴 Git repo dirty. Please run \"make docs\" and push the updated README. Failing CI."
+  exit 1
+fi