Skip to content

docs(site): document safe-outputs key validation errors#729

Merged
jamesadevine merged 1 commit into
mainfrom
docs/safe-outputs-key-validation-c3bcb621644887de
May 24, 2026
Merged

docs(site): document safe-outputs key validation errors#729
jamesadevine merged 1 commit into
mainfrom
docs/safe-outputs-key-validation-c3bcb621644887de

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Summary

  • Users now know that typos and old/renamed keys under safe-outputs: fail compilation immediately with a hint listing similar known tools — preventing the previous silent-drop behavior.
  • A caution callout in the Safe Outputs reference makes the compile-time key contract discoverable at the point of configuration.

Changes

  • site/src/content/docs/troubleshooting/common-issues.mdx:
    • Add "safe-outputs contains unrecognised tool name(s)" entry with the exact error format, a before/after YAML example (create-prcreate-pull-request), and a link to the full tool list.
    • Add "safe-outputs contains tool name(s) with invalid characters" entry showing the character constraint and a corrected example.
  • site/src/content/docs/reference/safe-outputs.mdx:
    • Add :::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

  • Error messages transcribed directly from src/compile/common.rs (validate_safe_outputs_keys function — added in PR feat(safeoutputs): add daily smoke suite and reject unknown safe-output keys #563).
  • create-prcreate-pull-request rename confirmed in src/safeoutputs/mod.rs (ALL_KNOWN_SAFE_OUTPUTS contains create-pull-request, not create-pr).
  • Character constraint (ASCII letters, digits, hyphens) confirmed against validate::is_safe_tool_name call 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.

Generated by Docs Writer · ● 9.1M ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot mentioned this pull request May 24, 2026
@jamesadevine jamesadevine marked this pull request as ready for review May 24, 2026 11:48
@jamesadevine jamesadevine merged commit 4fce5dd into main May 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant