Fix guided tour false positive in PR size check#51964
Merged
Conversation
The regex matches "guided tour" and "read in order" in the PR template's HTML comment placeholders, not actual content from the author. Strip HTML comments before testing.
5 tasks
swannysec
added a commit
that referenced
this pull request
Mar 19, 2026
## Context Follow-up to #51964. The previous fix (stripping HTML comments) still had a false positive: the `## How to Review` heading itself matched the `how to review` alternative in the regex. Every PR using the template would trigger the "guided tour detected" message. Replace the regex with structural detection: extract the "How to Review" section, strip template placeholders, and check if the author actually wrote content there. Also softens the confirmation message to "appears to include guidance." ## How to Review - Single file: `.github/workflows/pr-size-check.yml`, lines 147-154 - The `rawBody.match(...)` extracts content between `## How to Review` and the next `##` heading - Confirmed: PR #51957's body returns `false`, a PR with actual content returns `true` ## Self-Review Checklist - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable Release Notes: - N/A
AmaanBilwar
pushed a commit
to AmaanBilwar/zed
that referenced
this pull request
Mar 20, 2026
## Context The size check workflow's guided tour detection matches text inside HTML comment placeholders in the PR template (e.g., `<!-- provide a guided tour — numbered list of files/commits to read in order -->`), producing false positives like the one on zed-industries#51957. Fix: strip `<!-- -->` comments from the PR body before running the regex. ## How to Review - Single file: `.github/workflows/pr-size-check.yml`, lines 148-151 - The `.replace(/<!--[\s\S]*?-->/g, '')` runs in `actions/github-script` JS, not shell ## Self-Review Checklist - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable Release Notes: - N/A
AmaanBilwar
pushed a commit
to AmaanBilwar/zed
that referenced
this pull request
Mar 20, 2026
…#51969) ## Context Follow-up to zed-industries#51964. The previous fix (stripping HTML comments) still had a false positive: the `## How to Review` heading itself matched the `how to review` alternative in the regex. Every PR using the template would trigger the "guided tour detected" message. Replace the regex with structural detection: extract the "How to Review" section, strip template placeholders, and check if the author actually wrote content there. Also softens the confirmation message to "appears to include guidance." ## How to Review - Single file: `.github/workflows/pr-size-check.yml`, lines 147-154 - The `rawBody.match(...)` extracts content between `## How to Review` and the next `##` heading - Confirmed: PR zed-industries#51957's body returns `false`, a PR with actual content returns `true` ## Self-Review Checklist - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable Release Notes: - N/A
toshmukhamedov
pushed a commit
to toshmukhamedov/zed
that referenced
this pull request
Mar 20, 2026
## Context The size check workflow's guided tour detection matches text inside HTML comment placeholders in the PR template (e.g., `<!-- provide a guided tour — numbered list of files/commits to read in order -->`), producing false positives like the one on zed-industries#51957. Fix: strip `<!-- -->` comments from the PR body before running the regex. ## How to Review - Single file: `.github/workflows/pr-size-check.yml`, lines 148-151 - The `.replace(/<!--[\s\S]*?-->/g, '')` runs in `actions/github-script` JS, not shell ## Self-Review Checklist - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable Release Notes: - N/A
toshmukhamedov
pushed a commit
to toshmukhamedov/zed
that referenced
this pull request
Mar 20, 2026
…#51969) ## Context Follow-up to zed-industries#51964. The previous fix (stripping HTML comments) still had a false positive: the `## How to Review` heading itself matched the `how to review` alternative in the regex. Every PR using the template would trigger the "guided tour detected" message. Replace the regex with structural detection: extract the "How to Review" section, strip template placeholders, and check if the author actually wrote content there. Also softens the confirmation message to "appears to include guidance." ## How to Review - Single file: `.github/workflows/pr-size-check.yml`, lines 147-154 - The `rawBody.match(...)` extracts content between `## How to Review` and the next `##` heading - Confirmed: PR zed-industries#51957's body returns `false`, a PR with actual content returns `true` ## Self-Review Checklist - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable Release Notes: - N/A
AmaanBilwar
pushed a commit
to AmaanBilwar/zed
that referenced
this pull request
Mar 23, 2026
## Context The size check workflow's guided tour detection matches text inside HTML comment placeholders in the PR template (e.g., `<!-- provide a guided tour — numbered list of files/commits to read in order -->`), producing false positives like the one on zed-industries#51957. Fix: strip `<!-- -->` comments from the PR body before running the regex. ## How to Review - Single file: `.github/workflows/pr-size-check.yml`, lines 148-151 - The `.replace(/<!--[\s\S]*?-->/g, '')` runs in `actions/github-script` JS, not shell ## Self-Review Checklist - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable Release Notes: - N/A
AmaanBilwar
pushed a commit
to AmaanBilwar/zed
that referenced
this pull request
Mar 23, 2026
…#51969) ## Context Follow-up to zed-industries#51964. The previous fix (stripping HTML comments) still had a false positive: the `## How to Review` heading itself matched the `how to review` alternative in the regex. Every PR using the template would trigger the "guided tour detected" message. Replace the regex with structural detection: extract the "How to Review" section, strip template placeholders, and check if the author actually wrote content there. Also softens the confirmation message to "appears to include guidance." ## How to Review - Single file: `.github/workflows/pr-size-check.yml`, lines 147-154 - The `rawBody.match(...)` extracts content between `## How to Review` and the next `##` heading - Confirmed: PR zed-industries#51957's body returns `false`, a PR with actual content returns `true` ## Self-Review Checklist - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable Release Notes: - N/A
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
The size check workflow's guided tour detection matches text inside HTML comment placeholders in the PR template (e.g.,
<!-- provide a guided tour — numbered list of files/commits to read in order -->), producing false positives like the one on #51957.Fix: strip
<!-- -->comments from the PR body before running the regex.How to Review
.github/workflows/pr-size-check.yml, lines 148-151.replace(/<!--[\s\S]*?-->/g, '')runs inactions/github-scriptJS, not shellSelf-Review Checklist
Release Notes: