diff --git a/.github/workflows/generated-files.yaml b/.github/workflows/generated-files.yaml index 6469cae3501..a0823f7ad3a 100644 --- a/.github/workflows/generated-files.yaml +++ b/.github/workflows/generated-files.yaml @@ -43,3 +43,6 @@ jobs: git status --porcelain echo "Please run 'make generate-flags' and submit your changes'"; exit 1 fi + - name: Check metrics docs + run: | + make lint-metrics-md diff --git a/Makefile b/Makefile index e3f88a37a58..324548acd51 100644 --- a/Makefile +++ b/Makefile @@ -427,3 +427,10 @@ metrics-docs: tetra echo 'weight: 4' >> $(METRICS_DOCS_PATH) echo '---' >> $(METRICS_DOCS_PATH) $(CONTAINER_ENGINE) run --rm -v $(PWD):$(PWD) -w $(PWD) $(GO_IMAGE) ./tetra metrics-docs tetragon >> $(METRICS_DOCS_PATH) + +.PHONY: lint-metrics-md +lint-metrics-md: metrics-docs + @if [ -n "$$(git status --porcelain $(METRICS_DOCS_PATH))" ]; then \ + echo "metrics doc out of sync; please run 'make metrics-docs'" > /dev/stderr; \ + false; \ + fi