Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
d0cb6a5
Rename content in core Software Delivery docs
joepeeples Apr 30, 2025
3f24759
Rename content in guides; update nav menu name
joepeeples Apr 30, 2025
630a108
Rename content in additional pages
joepeeples Apr 30, 2025
0c21949
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples May 1, 2025
8e07d6f
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples May 1, 2025
56e624f
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples May 1, 2025
989311c
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples May 1, 2025
ce26107
Rename content folder, add redirect aliases
joepeeples May 2, 2025
80e7704
Update link URLs
joepeeples May 2, 2025
4e5c6c8
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples May 2, 2025
1fc34a0
Rename images subfolder; update img src references
joepeeples May 2, 2025
f7f7738
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples Jun 17, 2025
fd59a90
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples Jun 17, 2025
085dca0
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples Jul 9, 2025
03d9c1c
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples Jul 25, 2025
89fae95
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples Jul 31, 2025
cdb36ce
Additional renaming updates
joepeeples Jul 31, 2025
7e6d5d8
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples Jul 31, 2025
abcf6ca
Apply suggestions from Alicia's review
joepeeples Aug 1, 2025
1f27998
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples Aug 1, 2025
5721158
Apply suggestions from Alicia's review
joepeeples Aug 5, 2025
ba0f590
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples Aug 5, 2025
4c78149
Add blog link
joepeeples Aug 8, 2025
6e8da6a
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples Aug 8, 2025
b271088
Merge branch 'master' into joepeeples/10684-pr-gates
joepeeples Aug 18, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions config/_default/menus/main.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5139,46 +5139,46 @@ menu:
parent: code_coverage
identifier: code_coverage_data_collected
weight: 2
- name: Quality Gates
url: quality_gates/
- name: PR Gates
url: pr_gates/
pre: ci
parent: software_delivery_heading
identifier: quality_gates
identifier: pr_gates
weight: 60000
- name: Setup
url: quality_gates/setup
parent: quality_gates
identifier: quality_gates_setup
url: pr_gates/setup
parent: pr_gates
identifier: pr_gates_setup
weight: 1
- name: Search and Manage
url: quality_gates/search
parent: quality_gates
identifier: quality_gates_search
url: pr_gates/search
parent: pr_gates
identifier: pr_gates_search
weight: 2
- name: Explorer
url: quality_gates/explorer
parent: quality_gates
identifier: quality_gates_explorer
url: pr_gates/explorer
parent: pr_gates
identifier: pr_gates_explorer
weight: 3
- name: Search Syntax
url: quality_gates/explorer/search_syntax
parent: quality_gates_explorer
identifier: quality_gates_explorer_search_syntax
url: pr_gates/explorer/search_syntax
parent: pr_gates_explorer
identifier: pr_gates_explorer_search_syntax
weight: 301
- name: Facets
url: quality_gates/explorer/facets
parent: quality_gates_explorer
identifier: quality_gates_explorer_facets
url: pr_gates/explorer/facets
parent: pr_gates_explorer
identifier: pr_gates_explorer_facets
weight: 302
- name: Saved Views
url: quality_gates/explorer/saved_views
parent: quality_gates_explorer
identifier: quality_gates_explorer_saved_views
url: pr_gates/explorer/saved_views
parent: pr_gates_explorer
identifier: pr_gates_explorer_saved_views
weight: 303
- name: Guides
url: quality_gates/guide
parent: quality_gates
identifier: quality_gates_guide
url: pr_gates/guide
parent: pr_gates
identifier: pr_gates_guide
weight: 4
- name: DORA Metrics
url: dora_metrics/
Expand Down
2 changes: 1 addition & 1 deletion content/en/data_security/data_retention_periods.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ attributes:
data_type: |
- **Events**: 15 months
- **User Profiles**: 30 days
- product: Quality Gates
- product: PR Gates
data_type: |
- **Gate evaluations**: 30 days
- product: Reference Tables
Expand Down
2 changes: 1 addition & 1 deletion content/en/getting_started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The table below lists a few examples of Datadog products:
<td><p><strong>Testing</strong></p></td>
<td>
<ul>
<li>Block faulty code from deploying to production with <a href="/quality_gates/">Quality Gates</a>.</li>
<li>Block faulty code from deploying to production with <a href="/pr_gates/">PR Gates</a>.</li>
<li>Simulate users around the globe to test your web app, API, or mobile application with <a href="/synthetics/">Synthetic Monitoring</a>.</li>
</ul>
</td>
Expand Down
8 changes: 4 additions & 4 deletions content/en/getting_started/code_security/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ To start running code scans in your IDE, see the respective documentation for yo
### Customize your repository settings
In [Code Security Settings][3], you can manage which repositories have PR comments enabled, as well as [customize the configuration][11] of which Static Code Analysis (SAST) rules are applied across or within repositories. For all the default rules provided by Datadog, see the [SAST Rules][4].

### Set up Quality Gates
### Set up PR Gates

Datadog provides [Quality Gates][6] as a platform capability to help you maintain and enforce security and quality standards for changes introduced to your codebase. For more information, see [Quality Gate setup][7].
Datadog provides [PR Gates][6] as a platform capability to help you maintain and enforce security and quality standards for changes introduced to your codebase. For more information, see [PR Gate setup][7].

## Prioritize vulnerabilities with runtime context

Expand Down Expand Up @@ -199,8 +199,8 @@ If no services or teams are found, Datadog uses the `CODEOWNERS` file in your re
[3]: https://app.datadoghq.com/security/configuration/code-security/setup
[4]: /security/code_security/static_analysis/static_analysis_rules/
[5]: /security/code_security/dev_tool_int/ide_plugins/
[6]: /quality_gates/
[7]: /quality_gates/setup
[6]: /pr_gates/
[7]: /pr_gates/setup
[8]: /security/code_security/software_composition_analysis/#datadog-severity-score
[9]: https://app.datadoghq.com/security/configuration/notification-rules
[10]: /account_management/teams/
Expand Down
152 changes: 152 additions & 0 deletions content/en/pr_gates/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
---
title: PR Gates
description: Learn how to use PR Gates to enable your team to control what code makes it to production.
is_beta: false
aliases:
- /quality_gates/
further_reading:
- link: "https://app.datadoghq.com/release-notes?category=Software%20Delivery"
tag: "Release Notes"
text: "Check out the latest Software Delivery releases! (App login required)"
- link: "https://www.datadoghq.com/blog/datadog-quality-gates/"
tag: "Blog"
text: "Enhance code reliability with Datadog Quality Gates"
- link: "https://www.datadoghq.com/blog/datadog-github-deployment-protection-rules/"
tag: "Blog"
text: "Use Datadog monitors as quality gates for GitHub Actions deployments"
- link: "/pr_gates/explorer"
tag: "Documentation"
text: "Learn about the PR Gates Explorer"
- link: "/account_management/audit_trail/"
tag: "Documentation"
text: "Learn about Audit Trail"
- link: "https://www.datadoghq.com/blog/datadog-flaky-tests/"
tag: "Blog"
text: "Flaky tests: their hidden costs and how to address flaky behavior"
- link: "https://www.datadoghq.com/blog/datadog-iac-security/"
tag: "Blog"
text: "Prevent cloud misconfigurations from reaching production with Datadog IaC Security"
---

{{< callout url="#" btn_hidden="true" header="Join the Preview!" >}}
PR Gates is in Preview.
{{< /callout >}}

{{< site-region region="gov" >}}
<div class="alert alert-warning">PR Gates is not available in the selected site ({{< region-param key="dd_site_name" >}}) at this time.</div>
{{< /site-region >}}

## Overview

PR Gates allow you to control software quality by configuring rules to block substandard code from deployment. You have control over what is merged into the default branch and deployed to production, and can ensure that the code running in production adheres to high quality standards, reducing incidents and minimizing unwanted behaviors.

{{< img src="pr_gates/setup/sca_2.png" alt="An SCA rule that triggers a failure if any library vulnerabilities with critical or high severity are detected in the repository." style="width:100%" >}}

Use PR Gates to:

* Create rules that block workflows using data in Datadog, ensuring that only code that meets your standards end up in production.
* Give your organization the ability to decide what code makes it to production, enhancing your deployment discipline and mitigating potential issues in live environments.
* Continually improve code quality and system performance with precise enforcement and customizable rules.

You can configure PR Gates rules for the following categories:

[Test Optimization][9]

: <br> - New flaky tests <br> - Code coverage

[Static Analysis][11]

: <br> - Code vulnerability violations <br> - Code quality violations

[Software Composition Analysis][12]

: <br> - Vulnerabilities <br> - Detected licenses

By integrating PR Gates [into your CI/CD pipelines][7] or allowing the [Datadog GitHub integration][13] to create status checks on your Pull Requests automatically (currently available for SCA rules only), you can create a robust framework for maintaining and improving software quality that aligns with your organization's operational goals and business objectives.

## Setup

PR Gates offers the following rule types:

{{< tabs >}}
{{% tab "Tests" %}}

You can create rules to block code from being merged that introduces new [flaky tests][101] or that decreases [code coverage][102].

{{< img src="pr_gates/setup/flaky_test_2.png" alt="A PR Gate rule that blocks when one or more flaky tests occur" style="width:80%" >}}

[101]: /tests/flaky_test_management/
[102]: /tests/code_coverage/

{{% /tab %}}
{{% tab "Static Analysis" %}}

You can create rules to block code from being merged when your repository has a certain number of code quality or code vulnerability violations.

{{< img src="pr_gates/setup/static_analysis_2.png" alt="A PR Gate rule that fails when one or more new code quality violations of error-level severity are contained in the repository" style="width:80%" >}}

{{% /tab %}}
{{% tab "Software Composition Analysis" %}}

You can create rules to block code from being merged when your repository has a certain number of library vulnerabilities or forbidden licenses.

{{< img src="pr_gates/setup/sca_2.png" alt="A PR Gate rule that fails when one or more critical or high severity library vulnerabilities are contained in the repository" style="width:80%" >}}

{{% /tab %}}
{{< /tabs >}}

To create a PR Gate rule, see the [Setup documentation][2].

## Search rules

You can evaluate and update quality control processes by accessing PR Gates rules on the [**PR Gates Rules** page][6]. Improve your deployment practices based on your project requirements and desired performance outcomes.

{{< img src="pr_gates/rules_list_2.png" alt="List of PR Gate rules in Datadog" style="width:100%" >}}

To search for PR Gate rules, see the [Search and Manage documentation][5].

## Analyze executions in the PR Gates Explorer

You can search and filter for PR Gates or rule executions, create visualizations, and export saved views of your search query on the [**PR Gates Executions** page][14].

{{< tabs >}}
{{% tab "Gates" %}}

{{< img src="pr_gates/explorer/gates_3.png" alt="PR Gate results in the PR Gates Explorer" style="width:100%" >}}

{{% /tab %}}
{{% tab "Rule Executions" %}}

{{< img src="pr_gates/explorer/executions_1.png" alt="PR Gate rule execution results in the PR Gates Explorer" style="width:100%" >}}

{{% /tab %}}
{{< /tabs >}}

For more information, see the [PR Gates Explorer documentation][8].

## Track changes in rules

You can view information about who created, modified, and deleted PR Gates rules in [Audit Trail][3].

{{< img src="pr_gates/audit_event.png" alt="A PR Gates event in Datadog Audit Trail" style="width:100%" >}}

For more information, see the [Audit Trail documentation][4].

## Further Reading

{{< partial name="whats-next/whats-next.html" >}}

[1]: /tests/flaky_test_management/
[2]: /pr_gates/setup/
[3]: /account_management/audit_trail/
[4]: /account_management/audit_trail/events/#ci-visibility-events
[5]: /pr_gates/search/
[6]: https://app.datadoghq.com/ci/pr-gates
[7]: https://github.com/DataDog/datadog-ci
[8]: /pr_gates/explorer/
[9]: /tests/
[10]: /continuous_integration/
[11]: /security/code_security/static_analysis
[12]: /security/code_security/software_composition_analysis
[13]: /integrations/github/
[14]: https://app.datadoghq.com/ci/pr-gates/
113 changes: 113 additions & 0 deletions content/en/pr_gates/explorer/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
title: PR Gates Explorer
description: Learn about the PR Gates Explorer for PR Gates and rule executions.
aliases:
- /continuous_integration/quality_gates/
- /quality_gates/explorer/
further_reading:
- link: "/pr_gates/"
tag: "Documentation"
text: "Learn about PR Gates"
- link: "/pr_gates/explorer/saved_views/"
tag: "Documentation"
text: "Learn about Saved Views"
---

{{< site-region region="gov" >}}
<div class="alert alert-warning">PR Gates is not available in the selected site ({{< region-param key="dd_site_name" >}}) at this time.</div>
{{< /site-region >}}

## Overview

The PR Gates Explorer allows you to [search and filter](#search-and-filter), [visualize](#visualize), and [export](#export) PR Gates or rule executions at multiple levels using any tag.

{{< tabs >}}
{{% tab "Gates" %}}

Navigate to [**Software Delivery** > **PR Gates** > **PR Gate Executions**][101] to see your PR Gates.

{{< img src="pr_gates/explorer/gates_3.png" text="PR Gate rules page" style="width:100%" >}}

The **PR Gates** panel on the left lists default facets you can use to search for your gates.

| Facet | Description |
|-----------------|---------------------------------------------------------------|
| Status | The PR Gate status: `Passed` or `Failed`. |
| Gate ID | The ID of the PR gate. |

## PR Gate details

You can see aggregated data about PR Gates over the selected time frame. Use the search field and facets to filter the list to show the gates you want to investigate.

### PR Gate data

PR Gate data is available in dashboards and notebooks, enabling build engineering teams to customize their communication about high-priority work and CI trends over time.

[101]: https://app.datadoghq.com/ci/pr-gates/
[102]: https://app.datadoghq.com/dashboard/lists
[103]: https://app.datadoghq.com/notebook/list

{{% /tab %}}
{{% tab "Rule Executions" %}}

Navigate to [**Software Delivery** > **PR Gates** > **PR Gate Executions**][101] to see your PR Gate rule executions.

{{< img src="pr_gates/explorer/rules_1.png" text="PR Gates Rule Executions page" style="width:100%" >}}

The **PR Gates** panel on the left lists default facets you can use to search for your rule executions.

| Facet | Description |
|-----------------|---------------------------------------------------------------|
| Status | The PR Gate status: `Passed` or `Failed`. |
| Rule Name | The user-given name to identify a particular rule. |
| Blocking Status | Determines whether or not the rule status will cause the CI workflow to fail: `true` or `false`. |
| Creator | The user who created the PR Gate rule. |
| Data Source | The source of data being evaluated for the rule (tests, static analysis). |
| Gate ID | The ID of the PR Gate. |

## Rule executions details

You can see aggregated data about rule executions over the selected time frame. Use the search field and facets to filter the list to show the executions you want to investigate.

### Rule execution data

PR Gate rules data is available in [dashboards][102] and [notebooks][103], enabling build engineering teams to customize their communication about high-priority work and CI trends over time.

[101]: https://app.datadoghq.com/ci/pr-gates/
[102]: https://app.datadoghq.com/dashboard/lists
[103]: https://app.datadoghq.com/notebook/list

{{% /tab %}}
{{< /tabs >}}

## Search and filter

You can narrow down, broaden, or shift your focus on a subset of PR Gates or rule executions by clicking on the facets to the left or writing your own custom query in the search bar. When you select and deselect facets, the search bar automatically reflects your changes. Similarly, you can modify the search bar query or write a query from scratch.

- To learn how to search for PR Gate rules, see [Search and Manage][1].
- To learn how to create queries, see [Search Syntax][2].

## Analyze

Group PR Gates or rule executions into higher-level fields, patterns, and transactions to derive or consolidate information. You do not need to create a facet in order to search for an attribute. Use [facets][3] to:

- **Identify trends and patterns in PR Gate executions**: Understand which repositories or pipelines are being blocked most often.
- **Identify trends and patterns in PR Gate Rule executions**: Understand which types of rules are failing most often across the organization.

## Visualize

Select a visualization type to visualize the outcomes of filters and aggregations and better understand your PR Gates or rule executions. For example, you can view gate results in a list to organize gates data into columns, or in a timeseries graph to measure gate execution data over time.

## Export

Export your view in the [PR Gates Explorer][5] to reuse it later or in different contexts. For more information, see [Saved Views][4].

## Further reading

{{< partial name="whats-next/whats-next.html" >}}

[1]: /pr_gates/search
[2]: /pr_gates/explorer/search_syntax
[3]: /pr_gates/explorer/facets
[4]: /pr_gates/explorer/saved_views
[5]: /pr_gates/explorer
Loading
Loading