docs(site): document safe-outputs key validation errors#729
Merged
jamesadevine merged 1 commit intoMay 24, 2026
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Open
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
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.
Summary
safe-outputs:fail compilation immediately with a hint listing similar known tools — preventing the previous silent-drop behavior.Changes
site/src/content/docs/troubleshooting/common-issues.mdx:create-pr→create-pull-request), and a link to the full tool list.site/src/content/docs/reference/safe-outputs.mdx::::caution[Compile-time key validation]callout in the intro section stating that all keys must be exact registered names and that the compiler rejects unknowns with a similar-tools hint.Accuracy checks
src/compile/common.rs(validate_safe_outputs_keysfunction — added in PR feat(safeoutputs): add daily smoke suite and reject unknown safe-output keys #563).create-pr→create-pull-requestrename confirmed insrc/safeoutputs/mod.rs(ALL_KNOWN_SAFE_OUTPUTScontainscreate-pull-request, notcreate-pr).ASCII letters, digits, hyphens) confirmed againstvalidate::is_safe_tool_namecall in the same function.Validation
cd site && npm ci && npm run build— 29 pages built, all internal links valid.Created by the docs-writer workflow.