Skip to content

fix(relayctl): harden editor diagnostics - #746

Merged
jeremi merged 1 commit into
mainfrom
fix/relayctl-editor-diagnostics
Aug 13, 2026
Merged

fix(relayctl): harden editor diagnostics#746
jeremi merged 1 commit into
mainfrom
fix/relayctl-editor-diagnostics

Conversation

@jeremi

@jeremi jeremi commented Aug 13, 2026

Copy link
Copy Markdown
Member

Summary

  • apply the categorical operational-message convention to editor setup failures
  • preserve symbolic-link refusal and recoverable publication behavior
  • add focused regression coverage for safe stderr rendering

Rationale

Editor-specific failures bypassed the CLI's categorical diagnostic convention. This aligns them with the existing Relay V2 tooling contract without changing project mutation behavior.

Validation

  • cargo fmt --check
  • cargo test --locked -p registry-relayctl
  • products/relay-v2/scripts/check-contracts.sh

Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
@jeremi
jeremi merged commit da3237d into main Aug 13, 2026
31 checks passed
@jeremi
jeremi deleted the fix/relayctl-editor-diagnostics branch August 13, 2026 05:02

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2a0ede0cc9

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Conflict(String),
#[error("editor setup refused a symbolic link at {0}")]
Symlink(String),
#[error("editor setup refused a symbolic link in its managed file set")]

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Add the required DCO sign-off

The reviewed commit has no Signed-off-by trailer, so it does not satisfy the repository's requirement that every commit carry a DCO sign-off. Recreate the commit with git commit -s before merging.

AGENTS.md reference: AGENTS.md:L274-L274

Useful? React with 👍 / 👎.

Comment on lines +129 to +131
#[error(
"editor setup publication failed; recoverable transaction files remain in the project directory"
)]

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Reuse the documented output-failure category

When publication fails, run_tooling writes this new Recovery display string directly to stderr, but the Relayctl reference says operational failures use one of the six messages listed in docs/site/src/content/docs/reference/relayctl.mdx:193-203; the applicable existing category is the requested authoring output could not be written. This introduces an undocumented message for callers that classify the supported categorical diagnostics, so retain the recovery files while rendering the standard output-failure category.

Useful? React with 👍 / 👎.

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