Skip to content

ref(develop): Add selective testing docs#17411

Merged
rbro112 merged 7 commits intomasterfrom
ryan/04-20-add_selective_testing_docs
Apr 21, 2026
Merged

ref(develop): Add selective testing docs#17411
rbro112 merged 7 commits intomasterfrom
ryan/04-20-add_selective_testing_docs

Conversation

@rbro112
Copy link
Copy Markdown
Member

@rbro112 rbro112 commented Apr 21, 2026

Adds basic selective testing develop docs.

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 21, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Apr 21, 2026 3:21pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
sentry-docs Ignored Ignored Preview Apr 21, 2026 3:21pm

Request Review

Comment thread develop-docs/backend/testing/selective-testing.mdx Outdated
@rbro112 rbro112 force-pushed the ryan/04-20-add_selective_testing_docs branch from 9d71f76 to b163951 Compare April 21, 2026 01:25
Comment thread develop-docs/backend/testing/index.msx Outdated
Comment on lines +1 to +6
---
title: Testing
sidebar_order: 70
---

Guides for testing backend code at Sentry.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The new documentation file index.tsx has the wrong file extension. It contains MDX content but uses .tsx, so it will be ignored by the documentation build process.
Severity: HIGH

Suggested Fix

Rename the file from develop-docs/backend/testing/index.tsx to develop-docs/backend/testing/index.mdx. This will allow the documentation pipeline to correctly identify and process it as an MDX file.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: develop-docs/backend/testing/index.tsx#L1-L6

Potential issue: The new documentation file `develop-docs/backend/testing/index.tsx`
uses a `.tsx` extension but contains MDX content, including YAML frontmatter. The
documentation generation pipeline, specifically functions in `src/frontmatter.ts` and
`src/mdx.ts`, is configured to only process files with `.md` or `.mdx` extensions. Due
to its `.tsx` extension, this file will be skipped by the pipeline. As a result, the
page will not be included in the static site generation, will be missing from the
sidebar navigation, and will be inaccessible, leading to a 404 error.

Comment thread tsconfig.json Outdated
"next-env.d.ts",
".next/types/**/*.ts"
]
, "develop-docs/backend/testing/index.msx" ]
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The new documentation file index.msx uses an incorrect extension. The build system only recognizes .md and .mdx files, so this page will not be rendered.
Severity: MEDIUM

Suggested Fix

Rename the file develop-docs/backend/testing/index.msx to develop-docs/backend/testing/index.mdx. Additionally, remove the entry for "develop-docs/backend/testing/index.msx" from the include array in tsconfig.json as it will no longer be necessary.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: tsconfig.json#L83

Potential issue: The pull request introduces a new documentation file
`develop-docs/backend/testing/index.msx` with a non-standard `.msx` extension. The
documentation build system, as seen in `src/frontmatter.ts`, is configured to only
process files with `.md` and `.mdx` extensions. Consequently, the new `.msx` file will
be silently ignored by the build pipeline. This will result in the intended navigation
index page for the backend testing section not being rendered or appearing in the
documentation hierarchy, leading to incomplete documentation. The addition of the file
path to `tsconfig.json` is an incorrect workaround that does not resolve the root issue.

Comment thread develop-docs/backend/testing/selective-testing.mdx Outdated

### Opting-out in CI

Have a paritcularly sensitive PR you want to run all tests on? Add the “Trigger: Override Selective Testing” label and your PR will run all tests.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Have a paritcularly sensitive PR you want to run all tests on? Add the “Trigger: Override Selective Testing” label and your PR will run all tests.
Have a particularly sensitive PR you want to run all tests on? Add the “Trigger: Override Selective Testing” label and your PR will run all tests.

@rbro112 rbro112 merged commit ce739d8 into master Apr 21, 2026
17 checks passed
@rbro112 rbro112 deleted the ryan/04-20-add_selective_testing_docs branch April 21, 2026 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants