Skip to content

Commit 1f887fe

Browse files
Updates for Rule Insight dashboard preview (#60507)
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
1 parent ee35c1d commit 1f887fe

3 files changed

Lines changed: 27 additions & 1 deletion

File tree

content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,29 @@ You can view insights for rulesets to see how rulesets are affecting a repositor
115115

116116
{% endif %}
117117

118+
{% ifversion rule-insights-dashboard %}
119+
120+
### Rule insights dashboard
121+
122+
> [!NOTE]
123+
> The rule insights dashboard is in {% data variables.release-phases.public_preview %} and subject to change. It is available for {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans.
124+
125+
The rule insights dashboard gives you a visual, high-level summary of rule evaluation activity for your repository, including:
126+
127+
- **Successes, failures, and bypasses over time**: A chart showing trends in rule evaluation results, helping you spot spikes in blocked pushes or unusual patterns.
128+
- **Top bypassers**: A list of the most active bypassers for your rulesets.
129+
130+
Each chart links back to the rule insights page with filters prefilled, so you can quickly drill into specific statuses, bypassers, or time ranges.
131+
132+
To view the dashboard:
133+
134+
{% data reusables.repositories.navigate-to-repo %}
135+
{% data reusables.repositories.sidebar-settings %}
136+
1. In the left sidebar, under "Code and automation," click **Rules**, then click **Insights**.
137+
1. At the top of the "Rule Insights" page, view the dashboard charts for an overview of rule evaluation activity.
138+
139+
{% endif %}
140+
118141
{% endif %}
119142

120143
{% ifversion push-rule-delegated-bypass %}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
versions:
2+
fpt: '*'
3+
ghec: '*'

data/reusables/repositories/about-ruleset-insights.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ On the "Rule Insights" page, you will see a timeline of the following user actio
66

77
If a ruleset is running in "Evaluate" mode, you can see actions that would have passed or failed if the ruleset had been active.
88

9-
Additonally these insights are availible via the rule suites [REST API](/rest/repos/rule-suites).
9+
Additionally, these insights are available via the rule suites [REST API](/rest/repos/rule-suites).
1010

1111
![Screenshot of the "Rule Insights" page. Three actions are listed marked: "Pass," "Bypass," and "Fail". The failed action has with an "evaluate" label.](/assets/images/help/repository/rule-insights.png)

0 commit comments

Comments
 (0)