PR Gates - new product flow [DOCS-10684] #30713

joepeeples · 2025-07-25T15:32:19Z

What does this PR do? What is the motivation?

Revises documentation for new PR Gates product.

Important

This PR builds on and targets the product renaming branch in #29089. When we're ready to merge, we need to merge the renaming PR first, then rebase this PR to main. This shouldn't affect any content being reviewed in the current PR.

Tip

For reviewers: Because of extensive revisions to multiple sections, the diff tab in GitHub looks pretty choppy and isn't great for reviewing. It's probably easier to review the preview as a whole, focusing on the main landing page and Setup page.

Merge instructions

Merge readiness:

Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

Additional notes

Smol change for testing, open PR

github-actions · 2025-07-25T15:32:37Z

ℹ️ Documentation Team Review

No documentation team review is required for this pull request.

github-actions · 2025-07-25T15:36:00Z

Preview links (active after the `build_preview` check completes)

Removed or renamed files (these should redirect)

Modified Files

no Explorer view currently

Search not currently available, and no longer enough content to justify having a separate Manage page. Also adds redirect alias for the removed page.

The "Executions" page in the app no longer exists, so links to it will 404. For now I'm just changing to the main PR Gates app page to avoid breaks, and we'll remove the full Explorer content & links in #30713

…es-new-product-flow

forgot to save

…es-new-product-flow

Audit Trail does not seem supported yet for PR Gates

joepeeples · 2025-08-08T15:34:25Z

Opened DOCS-11772 for editorial review.

…es-new-product-flow

drichards-87

Looks good! Approving the PR. I just had one small suggestion and a comment re: a product name.

drichards-87 · 2025-08-12T15:23:02Z

content/en/pr_gates/_index.md

+| [**Static Code Analysis**][11] | <li> Code vulnerability violations <li> Code quality violations |
+| [**Software Composition Analysis**][12] | <li> Library vulnerability violations <li> Detected license violations |
+| [**Code Coverage**][15] | <li> Total code coverage threshold <li> Patch code coverage threshold |
+| [**Infrastructure as Code Scanning**][16] | <li> IaC vulnerability severity |


Just noting that we recently changed the name to Infrastructure as Code Security. But it looks like the UI still refers to it as Infrastructure as Code Scanning. Could we pass this feedback along to the PR Gates PM?

drichards-87 · 2025-08-12T15:36:29Z

content/en/pr_gates/setup/_index.md

+[11]: https://learn.microsoft.com/en-us/azure/devops/repos/git/pull-request-status?view=azure-devops
+[12]: https://app.datadoghq.com/integrations/github
+[13]: https://app.datadoghq.com/integrations/azure-devops-source-code
+[14]: https://docs.datadoghq.com/integrations/github/


Suggested change

[14]: https://docs.datadoghq.com/integrations/github/

[14]: /integrations/github/

markazerdd · 2025-08-15T18:39:16Z

content/en/pr_gates/_index.md

-: <br> - Vulnerabilities <br> - Detected licenses
+| Source type     | Condition types |
+| --- | ----------- |
+| [**Static Code Analysis**][11] | <li> Code vulnerability violations <li> Code quality violations |


markazerdd · 2025-08-15T18:39:35Z

content/en/pr_gates/_index.md

+| Source type     | Condition types |
+| --- | ----------- |
+| [**Static Code Analysis**][11] | <li> Code vulnerability violations <li> Code quality violations |
+| [**Software Composition Analysis**][12] | <li> Library vulnerability violations <li> Detected license violations |


Suggested change

| [**Software Composition Analysis**][12] | <li> Library vulnerability violations <li> Detected license violations |

| [**Software Composition Analysis**][12] | <li> Library vulnerabilities <li> Library license violations |

markazerdd · 2025-08-15T18:40:56Z

content/en/pr_gates/_index.md

+| --- | ----------- |
+| [**Static Code Analysis**][11] | <li> Code vulnerability violations <li> Code quality violations |
+| [**Software Composition Analysis**][12] | <li> Library vulnerability violations <li> Detected license violations |
+| [**Code Coverage**][15] | <li> Total code coverage threshold <li> Patch code coverage threshold |


markazerdd · 2025-08-15T18:41:12Z

content/en/pr_gates/_index.md

+| [**Static Code Analysis**][11] | <li> Code vulnerability violations <li> Code quality violations |
+| [**Software Composition Analysis**][12] | <li> Library vulnerability violations <li> Detected license violations |
+| [**Code Coverage**][15] | <li> Total code coverage threshold <li> Patch code coverage threshold |
+| [**Infrastructure as Code Scanning**][16] | <li> IaC vulnerability severity |


markazerdd · 2025-08-15T18:42:45Z

content/en/pr_gates/_index.md

-
-{{% /tab %}}
-{{% tab "Static Analysis" %}}
+{{% tab "Static Code Analysis" %}}


Suggested change

{{% tab "Static Code Analysis" %}}

{{% tab "Static Code Analysis (SAST)" %}}

markazerdd · 2025-08-15T18:43:46Z

content/en/pr_gates/_index.md


-{{< 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%" >}}
+{{< img src="pr_gates/setup/static_analysis_3.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" %}}


Suggested change

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

{{% tab "Software Composition Analysis (SCA)" %}}

markazerdd · 2025-08-15T18:44:28Z

content/en/pr_gates/_index.md


 {{% /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.
+You can create rules to block code from being merged when a pull request introduces at least one library vulnerability or forbidden license of a certain severity.


Suggested change

You can create rules to block code from being merged when a pull request introduces at least one library vulnerability or forbidden license of a certain severity.

You can create rules to block code from being merged when a pull request introduces at least one library vulnerability of a certain severity or at least one library with a forbidden license.

markazerdd · 2025-08-15T18:45:27Z

content/en/pr_gates/_index.md

-
-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. 
+{{% tab "Code Coverage" %}}
+You can create rules to block code from being merged when a pull request causes the repository's overall code coverage to fall below a certain percentage.


Suggested change

You can create rules to block code from being merged when a pull request causes the repository's overall code coverage to fall below a certain percentage.

You can create rules to block code from being merged when a pull request causes the repository's overall code coverage to fall below a certain percentage or if the patch coverage is below a certain threshold.

markazerdd · 2025-08-15T18:47:27Z

content/en/pr_gates/_index.md


-You can view information about who created, modified, and deleted PR Gates rules in [Audit Trail][3].
+You can evaluate and update quality control processes by accessing PR Gates rules on the [**PR Gates Rules**][6] page. Improve your deployment practices based on your project requirements and desired performance outcomes. 


Suggested change

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

You can managed and update PR Gates rules on the [**PR Gates Rules**][6] page. Improve your security and quality practices based on your project requirements and risk tolerances.

markazerdd · 2025-08-15T18:47:42Z

content/en/pr_gates/_index.md


-{{< img src="pr_gates/audit_event.png" alt="A PR Gates event in Datadog Audit Trail" style="width:100%" >}}
+This view is useful for developers who want to keep an eye on the PR gates for their build pipelines. You can see all of the rules defined by the organization.


Suggested change

This view is useful for developers who want to keep an eye on the PR gates for their build pipelines. You can see all of the rules defined by the organization.

You can see all of the rules defined by the organization.

Redo table

93df0d4

Smol change for testing, open PR

joepeeples added WORK IN PROGRESS No review needed, it's a wip ;) Do Not Merge Just do not merge this PR :) labels Jul 25, 2025

joepeeples changed the title ~~PR Gates - new product flow~~ PR Gates - new product flow [DOCS-10684] Jul 25, 2025

joepeeples mentioned this pull request Jul 25, 2025

PR Gates - renaming [DOCS-10684] #29089

Open

1 task

Update images, image file names; assorted edits

9c97c89

github-actions bot added the Images Images are added/removed with this PR label Jul 25, 2025

joepeeples added 3 commits July 25, 2025 15:13

Remove Explorer and subpages

db637b3

no Explorer view currently

Redirect aliases for removed Explorer pages

0ddfcf4

Remove "Search and Manage" page

0ad40d6

Search not currently available, and no longer enough content to justify having a separate Manage page. Also adds redirect alias for the removed page.

github-actions bot added the Architecture Everything related to the Doc backend label Jul 25, 2025

Revise Setup page

027eb87

joepeeples added 5 commits July 31, 2025 11:59

Merge branch 'joepeeples/10684-pr-gates' into joepeeples/10684-pr-gat…

9f86817

…es-new-product-flow

Delete files for Explorer and Search

34714db

Remove commented line

fbb2a2d

Actually remove it this time

6a96ac6

forgot to save

Merge branch 'joepeeples/10684-pr-gates' into joepeeples/10684-pr-gat…

cd96d64

…es-new-product-flow

joepeeples marked this pull request as ready for review August 1, 2025 21:25

joepeeples requested a review from a team as a code owner August 1, 2025 21:25

joepeeples added 8 commits August 1, 2025 17:30

Merge branch 'joepeeples/10684-pr-gates' into joepeeples/10684-pr-gat…

de829d1

…es-new-product-flow

Merge branch 'joepeeples/10684-pr-gates' into joepeeples/10684-pr-gat…

c29c911

…es-new-product-flow

Remove Audit Trail section

ebf5462

Audit Trail does not seem supported yet for PR Gates

Minor cleanup: Integrate in CI/CD section

953a92f

Revise status check section

029a737

Clean up status checks section

1e069f6

Clean up links

5c493a7

Preview banner

ab8fc3d

Site support banner (switch to yaml)

da67a78

joepeeples requested a review from a team as a code owner August 6, 2025 19:18

joepeeples added editorial review Waiting on a more in-depth review and removed WORK IN PROGRESS No review needed, it's a wip ;) Do Not Merge Just do not merge this PR :) labels Aug 8, 2025

Merge branch 'joepeeples/10684-pr-gates' into joepeeples/10684-pr-gat…

97cc00c

…es-new-product-flow

drichards-87 approved these changes Aug 12, 2025

View reviewed changes

markazerdd reviewed Aug 15, 2025

View reviewed changes

Update inaccuracies outside of the diff of the PR

910e725

	[14]: https://docs.datadoghq.com/integrations/github/
	[14]: /integrations/github/

	\| [Static Code Analysis][11] \| <li> Code vulnerability violations <li> Code quality violations \|
	\| [Static Code Analysis][11] \| <li> Code vulnerabilities <li> Code quality violations \|

	\| [Software Composition Analysis][12] \| <li> Library vulnerability violations <li> Detected license violations \|
	\| [Software Composition Analysis][12] \| <li> Library vulnerabilities <li> Library license violations \|

	\| [Code Coverage][15] \| <li> Total code coverage threshold <li> Patch code coverage threshold \|
	\| [Code Coverage][15] \| <li> Total code coverage <li> Patch code coverage \|

	\| [Infrastructure as Code Scanning][16] \| <li> IaC vulnerability severity \|
	\| [Infrastructure as Code Scanning][16] \| <li> IaC vulnerabilities \|

	{{% tab "Static Code Analysis" %}}
	{{% tab "Static Code Analysis (SAST)" %}}

	{{% tab "Software Composition Analysis" %}}
	{{% tab "Software Composition Analysis (SCA)" %}}

	You can create rules to block code from being merged when a pull request introduces at least one library vulnerability or forbidden license of a certain severity.
	You can create rules to block code from being merged when a pull request introduces at least one library vulnerability of a certain severity or at least one library with a forbidden license.


		You can view information about who created, modified, and deleted PR Gates rules in [Audit Trail][3].
		You can evaluate and update quality control processes by accessing PR Gates rules on the [PR Gates Rules][6] page. Improve your deployment practices based on your project requirements and desired performance outcomes.

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


		{{< img src="pr_gates/audit_event.png" alt="A PR Gates event in Datadog Audit Trail" style="width:100%" >}}
		This view is useful for developers who want to keep an eye on the PR gates for their build pipelines. You can see all of the rules defined by the organization.

	This view is useful for developers who want to keep an eye on the PR gates for their build pipelines. You can see all of the rules defined by the organization.
	You can see all of the rules defined by the organization.

PR Gates - new product flow [DOCS-10684] #30713

Are you sure you want to change the base?

PR Gates - new product flow [DOCS-10684] #30713

Uh oh!

Conversation

joepeeples commented Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do? What is the motivation?

Merge instructions

Additional notes

Uh oh!

github-actions bot commented Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ℹ️ Documentation Team Review

Uh oh!

github-actions bot commented Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Preview links (active after the build_preview check completes)

Removed or renamed files (these should redirect)

Modified Files

Uh oh!

joepeeples commented Aug 8, 2025 • edited by jira bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

drichards-87 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

joepeeples commented Jul 25, 2025 •

edited

Loading

github-actions bot commented Jul 25, 2025 •

edited

Loading

github-actions bot commented Jul 25, 2025 •

edited

Loading

Preview links (active after the `build_preview` check completes)

joepeeples commented Aug 8, 2025 •

edited by jira bot

Loading