Skip to content

Commit b13424f

Browse files
authored
add docs on reducing pr noise (#2475)
1 parent ebc8d22 commit b13424f

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

docs/ce/howto/noise-reduction.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Reducing PR Noise
3+
---
4+
5+
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.
6+
While this is noise to see a quick history of activity within the PR, it gets noisy for anything over 10 impacted projects.
7+
8+
In such cases you can disable the reporting entirely using digger.yml:
9+
10+
```
11+
reporting:
12+
comments_enabled: false
13+
```
14+
15+
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
16+
17+
18+
![](/images/howto/checks.png)

docs/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
{
9191
"group": "How To",
9292
"pages": [
93+
"ce/howto/noise-reduction",
9394
"ce/howto/specify-terraform-version",
9495
"ce/howto/caching-strategies",
9596
"ce/howto/apply-on-merge",

docs/images/howto/checks.png

355 KB
Loading

0 commit comments

Comments
 (0)