diff --git a/docs/ce/howto/noise-reduction.mdx b/docs/ce/howto/noise-reduction.mdx new file mode 100644 index 000000000..4d4c7ace2 --- /dev/null +++ b/docs/ce/howto/noise-reduction.mdx @@ -0,0 +1,18 @@ +--- +title: Reducing PR Noise +--- + +The current behaviour of digger is that it leaves a comment for every plan or apply performed. It also leaves a summary comment on top of those. +While this is noise to see a quick history of activity within the PR, it gets noisy for anything over 10 impacted projects. + +In such cases you can disable the reporting entirely using digger.yml: + +``` +reporting: + comments_enabled: false +``` + +With that in place you will no longer see an individual plan per comment, you can go into the checks page to see the individual plans + + +![](/images/howto/checks.png) diff --git a/docs/docs.json b/docs/docs.json index 73c5aafc4..d839592a8 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -90,6 +90,7 @@ { "group": "How To", "pages": [ + "ce/howto/noise-reduction", "ce/howto/specify-terraform-version", "ce/howto/caching-strategies", "ce/howto/apply-on-merge", diff --git a/docs/images/howto/checks.png b/docs/images/howto/checks.png new file mode 100644 index 000000000..6bf518b22 Binary files /dev/null and b/docs/images/howto/checks.png differ