Move "how ngrok works" content to Gateway section, create new page in About section - #2230
Open
sg-writer wants to merge 3 commits into
Open
Move "how ngrok works" content to Gateway section, create new page in About section#2230sg-writer wants to merge 3 commits into
sg-writer wants to merge 3 commits into
Conversation
sg-writer
added
docs/content
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
sg-writer
commented
Jul 27, 2026
Co-authored-by: SG <212444234+sg-writer@users.noreply.github.com>
sg-writer
added a commit
that referenced
this pull request
Jul 30, 2026
## Problem The Vale check has been failing on PRs without posting any reviewdog review comments. Two compounding bugs: **1. The changed-files step lints the wrong files.** ``` git diff base.sha github.sha ``` On a `pull_request` event, `github.sha` is the *ephemeral merge commit* — the PR head merged into main's **current** tip — while `base.sha` is where the branch diverged. So this two-dot diff returns the PR's changes **plus every change main landed since the branch was cut**. On #2230 that meant Vale linted ~140 files instead of 2. **2. `filter_mode: nofilter` turns that into a hard failure.** reviewdog's `github-pr-review` reporter can't attach a review comment to a file outside the PR diff — the review API has nowhere to put it. So it silently downgrades those findings to GitHub Actions log annotations ([`service/github/github.go#L132`](https://github.com/reviewdog/reviewdog/blob/v0.17.0/service/github/github.go#L132)), and that writer caps at 10 and **errors above 9**: ```go const MaxLoggingAnnotationsPerStep = 10 func (lw *GitHubActionLogWriter) Flush(...) error { if lw.reportNum > 9 { return fmt.Errorf("...reported too many annotation (N=%d)", ...) } ``` Runs hit 22 → exit 1 → **red check, zero review comments**. `fail_on_error: false` doesn't cover it, since this is a reporter failure rather than a lint failure. This is not branch-specific. The identical signature (`N=22`, same messages) appears on run `30294923756` on `clarify-agent-tls-termination`, and no reviewdog comment exists on any recent PR — the workflow has likely never successfully posted one. ## Fix - **Take the file list from the `pulls/{n}/files` API** rather than git plumbing. That's exactly the set reviewdog diffs against, with no base drift and no race. - **`filter_mode: file` instead of `nofilter`.** This is what the existing comment already described wanting — every issue in a changed file, not just added lines. It's also a structural safety net: out-of-diff findings get dropped rather than triggering the log-writer fallback if the file list ever goes wide again. In-file-but-outside-the-hunk findings still post fine — reviewdog routes those through `buildPullRequestComment` with `SubjectType: "file"`, so MDX line-number drift (the original reason for `nofilter`) isn't a problem. ## Verification - New file-list logic run against real PR #2230: `["gateway/how-it-works.mdx","how-ngrok-works.mdx"]` — 2 files, down from ~140. - Local Vale reproduces the CI findings exactly (`integrations/webhooks/zendesk-webhooks.mdx:82:110` etc.), confirming all 22 came from drifted, unrelated files. - Local Vale finds **zero** issues in #2230's two actual files, so that check should go green once this lands. - Workflow YAML parses. Note: this PR touches only a `.yml` file, so its own Vale run will skip the lint step (`has_files=false`). The first real exercise of the reporter path will be the next PR that touches an mdx file with findings. Left alone as unrelated scope: `fetch-depth: 0` on the checkout is now dead weight, since nothing git-diffs anymore.
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.
Currently the How ngrok Works page in the docs describes Gateway specifically. So this PR moves that content to a new page in the Gateway section, and establishes the About section page as an umbrella to briefly introduce the products and point users to their specific "how it works" pages.