Repository navigation
Improve Cloud VM error guidance #4094
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
122efa8
Improve Cloud VM error guidance
lawrencecchen c1ddbbe
Merge remote-tracking branch 'origin/main' into feat-cloud-vm-actiona…
lawrencecchen f31ec1c
Merge remote-tracking branch 'origin/main' into feat-cloud-vm-actiona…
lawrencecchen 62606b1
Address final Cloud VM review feedback
lawrencecchen eeec2dd
Narrow Cloud VM sanitizer env var block
lawrencecchen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # User-Facing Error Messages | ||
|
|
||
| Flag production changes that add or materially change user-facing errors, alerts, command output, API error bodies, or recovery copy when they expose implementation details. | ||
|
|
||
| Fail when user-facing text includes: | ||
|
|
||
| - Upstream vendor or service names unless the user explicitly configured that vendor in the product UI. | ||
| - Internal provider names, provider-specific flags, templates, snapshots, manifests, environment variable names, database or migration details. | ||
| - Raw upstream error messages, stack traces, request ids from third-party systems, billing item ids, billing customer ids, or team ids unless the user supplied that exact id in the request. | ||
| - Secret material, credentials, tokens, headers, private keys, refresh tokens, session ids, or unredacted payload dumps. | ||
|
|
||
| Expected shape: | ||
|
|
||
| - State what happened in cmux/product terms. | ||
| - Give one or two concrete next actions the user can take. | ||
| - Put only safe, minimal diagnostics in `details`. | ||
| - Keep provider, billing, database, and auth implementation details in sanitized logs or internal telemetry, not in user-visible text. | ||
|
|
||
| Allowed cases: | ||
|
|
||
| - Developer-only comments, tests, docs, and operational runbooks that are not shown to end users. | ||
| - Existing public CLI flags or config keys in help text when the user asked for advanced configuration help. | ||
| - Generic terms such as "billing", "team", "Cloud VM service", or "Cloud VM state". |
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.