Skip to content

docs(adr): add remote result publication ADR - #142

Merged
delete-cloud merged 1 commit into
mainfrom
adr-0024-remote-result-publication
May 13, 2026
Merged

delete-cloud merged 1 commit into
mainfrom
adr-0024-remote-result-publication

Conversation

@delete-cloud

@delete-cloud delete-cloud commented May 13, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Adds ADR-0024 for remote result publication as the next remote milestone.
  • Reframes cloud sessions around session result, diff, Git-backed branch/PR publication, and explicit export fallback.
  • Captures implementation plan and acceptance criteria for Git-backed workspace sources, diff/patch APIs, CLI result-first behavior, and branch/PR publishing.

Test Plan

  • grep -n '[[:blank:]]$' docs/adr/0024-remote-result-publication.md
  • uv run python - <<'PY' ... required ADR sections present ... PY

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added documentation defining remote result publication capabilities, including structured code results with diffs and metadata, Git-backed workspace publication support with branch and commit tracking, HTTP API endpoints for result retrieval, and updated CLI workflows for publishing remote session results.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 13, 2026 •

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e6f619e2-8d47-4749-b1ce-558058f78afb

📥 Commits

Reviewing files that changed from the base of the PR and between 7b5a4fd and 0ddf683.

📒 Files selected for processing (1)
  • coding-agent/docs/adr/0024-remote-result-publication.md

📝 Walkthrough

Walkthrough

This pull request introduces ADR-0024, defining the remote product boundary for session result publication. The decision specifies a canonical session result contract with Git-backed workspace source semantics, HTTP API routes for result/diff/patch retrieval and explicit publication, and updated CLI workflows requiring explicit follow-on commands for branch/PR publication while forbidding silent automatic operations.

Changes

Remote Result Publication Architecture Decision

Layer / File(s) Summary
Problem statement and core decision
coding-agent/docs/adr/0024-remote-result-publication.md
Establishes motivation for remote result publication (limitations of snapshot transfer for review/branch/PR workflows). Introduces canonical session result contract: durable session status, reviewable code results (diffs/patches), optional Git-backed publication metadata, and explicit export fallbacks.
Workspace source model and publication constraints
coding-agent/docs/adr/0024-remote-result-publication.md
Defines Git-backed workspace source requirements (clone with .git, compute diffs/commits/push/PR when credentials allow, enforce base_sha, require explicit fallback for dirty repos). Establishes fail-closed HTTP API semantics forbidding automatic pushing/PR/overwrite without explicit request.
CLI and API user contracts
coding-agent/docs/adr/0024-remote-result-publication.md
remote run becomes result-first without default overwrite. Patch/archival download and branch/PR publication require explicit commands. HTTP API includes session-scoped result/diff/patch retrieval and explicit publish operation. remote download fallback retains manifest confirmation and overwrite protections.
Credentials configuration and operational consequences
coding-agent/docs/adr/0024-remote-result-publication.md
Git push and provider API credentials (GitHub/GitLab) for PR/MR creation. Fail-closed behavior when credentials/identity missing. Consequences: review-first vs. local mutation trade-offs, Git reliance for history/rollback, CLI differentiation between Git-backed and snapshot-fallback runs.
Implementation roadmap and acceptance criteria
coding-agent/docs/adr/0024-remote-result-publication.md
Stepwise implementation plan: extend UI schemas and routes, add Git-backed workspace source, generate diff/patch, update CLI workflow, implement branch/GitHub PR publication. Rejected alternatives: archive-overwrite primacy, live sync, snapshot-only branching, automatic PR creation. Acceptance criteria and test validation commands.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • delete-cloud/Coding-Agent-Loop#136: Adds documentation ADRs for remote workspace execution boundaries; ADR-0024 complements existing remote-workflow documentation with result publication semantics.
  • delete-cloud/Coding-Agent-Loop#111: Establishes ADR-0019 remote execution/session framework; ADR-0024 extends the session result and publication boundary defined in the prior remote architecture decision.
  • delete-cloud/Coding-Agent-Loop#124: Adds ADR-0021 defining remote operations HTTP API contract; ADR-0024 extends the session/workspace API surface with result/diff/patch publication semantics.

Poem

🐰 A session result takes shape,
With diffs and patches to escape,
Git-backed wisdom, no silent plays,
Explicit commands light the ways!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(adr): add remote result publication ADR' accurately describes the main change—adding a new architecture decision record (ADR-0024) for remote result publication.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch adr-0024-remote-result-publication

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@delete-cloud
delete-cloud merged commit bca687e into main May 13, 2026
1 check passed
@delete-cloud
delete-cloud deleted the adr-0024-remote-result-publication branch May 13, 2026 01:57
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