docs: document Project.BugReporter - #830
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Documents `<BugReporter.GitHub>` and the two modes behind it, under reference/extensions beside Api, Admin, Cli, Infra and Project, since that is where `BugReporter` is exported from. Two things get more room than the prop table, because both are easy to get wrong. Filing needs the token AND the repository, so a token on its own looks like it should work and silently does not. And `repository` defaults to webiny/webiny-js, so a project that configures nothing sends its users to Webiny's issue composer carrying their own page titles and click timeline. Also covers what the recorder captures, and the two rules that keep customer data out of an issue: field values are never read, and a label is only taken from an interactive element. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
adrians5j
force-pushed
the
adrian/bug-reporter-reference
branch
from
September 21, 2026 11:14
7213f92 to
8be70e5
Compare
The config component moved from a `BugReporter` export on `webiny/extensions` to `Project.BugReporter` (webiny/webiny-js#5746), so a sibling section next to Id, Telemetry, AutoInstall and FeatureFlags is the obvious home. One prop table beats two that drift, so the standalone page goes. The conceptual material is compressed rather than dropped: compose versus filed is two sentences, and the recorder is a paragraph instead of a seven-row table, which keeps this in proportion to FeatureFlags above it. Adds a second bolded gotcha alongside "filing needs token and repository": environment variables have to be guarded with `|| ""`, because an unset key renders as an object rather than undefined and fails the new params schema mid-build. That one bit the feature's own PR. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
adrians5j
changed the title
This branch was successfully deployed
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.
Documents the bug reporter, which shipped in webiny/webiny-js#5736, as a
### Project.BugReportersection in the existing Project extensions reference.Targets
release/6.6.0(#808) rather thanmaster, so it ships with the release the feature is in.Why it is not its own page
It first landed as
<BugReporter.GitHub>from a separateBugReporterexport onwebiny/extensions, and this PR originally added a page for it. That export is gone: the config component is now<Project.BugReporter>(webiny/webiny-js#5746), which makes a sibling section next to Id, Telemetry, AutoInstall and FeatureFlags the obvious home. One prop table beats two that drift.The conceptual material is compressed rather than dropped. Compose versus filed is two sentences, and the recorder is one paragraph instead of a seven-row table, which keeps the section in proportion to FeatureFlags above it.
Two bolded gotchas
Both are invisible from the types, and both fail quietly or confusingly:
tokenandrepositorytogether. The props are independently optional, so setting only the token reads like it should work. It leaves the reporter in compose mode instead.|| "". Reading an unset key offprocess.envwhile the config renders returns an object rather thanundefined, which fails the extension's string schema and stops the build. Every template already guards this way. This one bit the feature's own PR, which is how it got found.The default repository keeps its warning block: with no configuration a customer's compose URLs point at
webiny/webiny-js, prefilled with their page titles, URLs and click timeline.Checks
yarn generateandyarn validate:mdxboth fail on this base, on pages I did not touch. Neither report mentionsproject.mdx, and the section adds no internal links. Net diff is two files,project.mdxand its.ai.txt.yarn format:fixreformats 40-odd files that are already unformatted on this branch's base. I staged only mine and discarded that churn, so it is not in the diff.Still not in the 6.6.0 changelog
Last regenerated on 16 September, before the feature merged. Whoever regenerates before release will pick up #5736 and #5746 from the release commits, with a
REVIEW-PENDINGmarker. Nothing hand-added here, since a manual entry would be overwritten on the next run.Workspace: wby-next3 · ✨ BUG REPORTER - FINALS
🤖 Generated with Claude Code