Skip to content

refactor(workflow): S18 documentation settings and release notes#1591

Open
gsxdsm wants to merge 4 commits into
feature/workflow-owned-merge-s17-cutover-matrixfrom
feature/workflow-owned-merge-s18-docs-settings-release
Open

refactor(workflow): S18 documentation settings and release notes#1591
gsxdsm wants to merge 4 commits into
feature/workflow-owned-merge-s17-cutover-matrixfrom
feature/workflow-owned-merge-s18-docs-settings-release

Conversation

@gsxdsm

@gsxdsm gsxdsm commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Stack Slice

  • Slice: S18
  • Milestone: Release
  • Base branch: feature/workflow-owned-merge-s17-cutover-matrix
  • Full plan: docs/plans/2026-06-09-003-refactor-workflow-owned-merge-full-migration-slices-plan.md

Goal

Update architecture, settings, dashboard, CLI, and testing docs for workflow-owned policy and compatibility projections.

Dependency

S17 end-to-end cutover matrix.

Expected Scope

docs/architecture.md; docs/workflow-steps.md; docs/dashboard-guide.md; docs/settings-reference.md; docs/testing.md; CONCEPTS.md; changeset.

Expected Tests

Docs inventory/search tests where applicable; lazy view inventory unchanged unless dashboard imports change.

Exit Gate

User-facing docs use the same state names as API/UI tests, and a patch changeset exists if published behavior changed.

Status

Draft stack placeholder. This PR reserves ordering and review context; implementation should replace or extend the handoff artifact before this slice is marked ready.

Implementation Added

  • Added docs/workflow-owned-merge-runtime.md documenting the implemented runtime APIs and deletion guards.\n- Linked the runtime doc from architecture and testing guidance.

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f3ffde5c-91f3-4d0e-b41d-15cbe03791c0

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • ✅ Review completed - (🔄 Check again to review again)
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/workflow-owned-merge-s18-docs-settings-release

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.

@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s17-cutover-matrix branch from 6e69a10 to 1c32f07 Compare June 9, 2026 20:31
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch from 724670a to 254a3bf Compare June 9, 2026 20:31
@gsxdsm gsxdsm marked this pull request as ready for review June 9, 2026 20:35
@greptile-apps

greptile-apps Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR delivers the S18 documentation layer for the workflow-owned merge migration stack, adding a runtime API reference document, glossary terms, an architecture patterns solutions doc, testing guidance, and a plan handoff artifact. All API surface names, state literals, and kind values in the new docs were verified against the source (WORKFLOW_WORK_ITEM_STATES, WORKFLOW_WORK_ITEM_KINDS in packages/core/src/types.ts) and the implementation files.

  • docs/workflow-owned-merge-runtime.md documents the implemented runtime surfaces (claimDueWorkflowWorkItem, runWorkItem, publishWorkflowRecoveryEvent, projectWorkflowWorkStatus) along with the four deletion-guard test files.
  • docs/solutions/architecture-patterns/workflow-owned-merge-stack-feedback-resolution.md captures the stacked-PR review-feedback workflow and includes correction patterns (projection cleanup, classifier routing, retry nullish checks, recovery events, guard tests).
  • CONCEPTS.md adds "Workflow Work Item" and "Stacked PR" glossary entries; docs/testing.md adds targeted guidance for running migration guard tests.

Confidence Score: 5/5

Documentation-only changes with no runtime behavior modifications; safe to merge.

All six changed files are pure documentation. The state literals, kind values, and API surface names in the new runtime reference doc were verified directly against packages/core/src/types.ts and the implementation files — every value matches. All cross-referenced solution docs and the full-plan file exist on disk. The one inaccuracy found (nodeId vs kind label in a single bullet point) has a suggestion attached and does not affect any runtime behavior.

docs/workflow-owned-merge-runtime.md — one bullet mislabels the recovery-router nodeId as the work item kind (kind is recovery); a suggestion is attached.

Important Files Changed

Filename Overview
docs/workflow-owned-merge-runtime.md New runtime reference doc; all state/kind literals verified against types.ts, but 'recovery-router work' conflates nodeId with kind (kind is recovery, nodeId is recovery-router).
docs/solutions/architecture-patterns/workflow-owned-merge-stack-feedback-resolution.md New solutions doc capturing stacked-PR feedback patterns; code snippets are accurate, cross-references to related docs all exist.
CONCEPTS.md Adds Workflow Work Item and Stacked PR glossary terms in contextually correct positions; consistent with usage throughout the runtime docs.
docs/architecture.md Adds a short reference paragraph linking to workflow-owned-merge-runtime.md; relative path resolves correctly.
docs/testing.md Adds targeted guidance for migration guard tests; glob pattern workflow-*-deletion.test.ts correctly matches the three confirmed deletion-guard test files.
docs/plans/workflow-owned-merge-stack/s18-docs-settings-release.md Stack handoff artifact; full-plan reference resolves to an existing file.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    subgraph "Workflow-Owned Merge Runtime (documented in this PR)"
        WI["workflow_work_items\n(runnable/running/held/retrying/\nmanual-required/succeeded/\nfailed/cancelled/exhausted)"]
        CLAIM["claimDueWorkflowWorkItem\n(leases due work)"]
        RUN["WorkflowTaskRuntime.runWorkItem\n(executes leased node)"]
        MERGE["runWorkflowMergeAttemptNode\n(calls guarded merge primitive)"]
        RECOVERY["publishWorkflowRecoveryEvent\n(self-healing facts to\nrecovery work item\nat recovery-router node)"]
        PROJ_STATUS["projectWorkflowWorkStatus\n(workflow-first projection\nfor dashboard/API/CLI)"]
    end
    subgraph "Projection from Legacy"
        PROJ_MR["TaskStore.projectMergeRequestToWorkflowWorkItem"]
        HANDOFF["createCompletionHandoffWorkflowWork\n(merge-gate / merge-manual-hold)"]
    end
    subgraph "Cutover Guards"
        G1["workflow-scheduler-policy-deletion.test.ts"]
        G2["workflow-merge-policy-deletion.test.ts"]
        G3["workflow-self-healing-policy-deletion.test.ts"]
        G4["workflow-cutover-matrix.test.ts"]
    end
    PROJ_MR --> WI
    HANDOFF --> WI
    WI --> CLAIM
    CLAIM --> RUN
    RUN --> MERGE
    RUN --> RECOVERY
    RECOVERY --> WI
    WI --> PROJ_STATUS
    G1 -.->|guards against| WI
    G2 -.->|guards against| MERGE
    G3 -.->|guards against| RECOVERY
    G4 -.->|cutover matrix| WI
Loading

Reviews (11): Last reviewed commit: "fix(FN-000): complete workflow stack ver..." | Re-trigger Greptile

Comment thread docs/plans/workflow-owned-merge-stack/s18-docs-settings-release.md
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s17-cutover-matrix branch from 1c32f07 to 5fb5c9a Compare June 9, 2026 20:38
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch from 254a3bf to f640883 Compare June 9, 2026 20:38
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s17-cutover-matrix branch from 5fb5c9a to 75a1709 Compare June 9, 2026 20:48
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch from f640883 to 399823f Compare June 9, 2026 20:48
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s17-cutover-matrix branch from 75a1709 to db51323 Compare June 9, 2026 23:37
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch 3 times, most recently from 4252fe5 to 962767f Compare June 9, 2026 23:45
@gsxdsm

gsxdsm commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator Author

Addressed Greptile commit-message feedback by rewriting the S18 branch to a single compliant commit: fix(FN-000): document workflow-owned merge runtime with Fusion-Task-Id: FN-000 trailer (962767f64). The old docs(workflow): ... placeholder commits are no longer in the S18 branch history.

@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch from 962767f to 3b8a564 Compare June 10, 2026 00:23
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s17-cutover-matrix branch 2 times, most recently from 1fc96ee to 7beabf9 Compare June 10, 2026 03:48
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch 2 times, most recently from 279059b to 9427fae Compare June 10, 2026 03:53
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s17-cutover-matrix branch from 7beabf9 to 47bfa0e Compare June 10, 2026 03:53
gsxdsm added a commit that referenced this pull request Jun 10, 2026
Address PR #1591 feedback by separating workflow work item states from kinds in the runtime reference. The documented state list now matches WORKFLOW_WORK_ITEM_STATES, and recovery is documented as a kind.

Note: pre-existing failure in pnpm test:gate at packages/engine/src/__tests__/self-healing.test.ts not addressed by this PR feedback fix.
@gsxdsm

gsxdsm commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator Author

The new \workflow-owned-merge-runtime.md\\ lists \manual\\ and \recovery\\ as work-item states, but neither exists in the canonical \WORKFLOW_WORK_ITEM_STATES\\ enum.

Addressed: corrected docs/workflow-owned-merge-runtime.md so the persisted state list matches WORKFLOW_WORK_ITEM_STATES (runnable, running, held, retrying, manual-required, succeeded, failed, cancelled, exhausted) and documented recovery separately as a workflow work item kind.

gsxdsm added a commit that referenced this pull request Jun 11, 2026
Address PR #1591 feedback by separating workflow work item states from kinds in the runtime reference. The documented state list now matches WORKFLOW_WORK_ITEM_STATES, and recovery is documented as a kind.

Note: pre-existing failure in pnpm test:gate at packages/engine/src/__tests__/self-healing.test.ts not addressed by this PR feedback fix.
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s17-cutover-matrix branch from 47bfa0e to e7391a5 Compare June 11, 2026 15:25
gsxdsm added a commit that referenced this pull request Jun 11, 2026
Address PR #1591 feedback by including the scheduler deletion guard in the documented workflow-owned merge verification set.
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch from 895362d to 89bc786 Compare June 11, 2026 15:25
gsxdsm added a commit that referenced this pull request Jun 11, 2026
Address PR #1591 feedback by separating workflow work item states from kinds in the runtime reference. The documented state list now matches WORKFLOW_WORK_ITEM_STATES, and recovery is documented as a kind.

Note: pre-existing failure in pnpm test:gate at packages/engine/src/__tests__/self-healing.test.ts not addressed by this PR feedback fix.
gsxdsm added a commit that referenced this pull request Jun 11, 2026
Address PR #1591 feedback by including the scheduler deletion guard in the documented workflow-owned merge verification set.
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch from 89bc786 to c5c011c Compare June 11, 2026 15:35
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s17-cutover-matrix branch from e7391a5 to 61c1924 Compare June 11, 2026 15:35
gsxdsm added a commit that referenced this pull request Jun 11, 2026
Address PR #1591 feedback by separating workflow work item states from kinds in the runtime reference. The documented state list now matches WORKFLOW_WORK_ITEM_STATES, and recovery is documented as a kind.

Note: pre-existing failure in pnpm test:gate at packages/engine/src/__tests__/self-healing.test.ts not addressed by this PR feedback fix.
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s17-cutover-matrix branch from 61c1924 to e7b76ff Compare June 11, 2026 15:39
gsxdsm added a commit that referenced this pull request Jun 11, 2026
Address PR #1591 feedback by including the scheduler deletion guard in the documented workflow-owned merge verification set.
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch from c5c011c to 3a31499 Compare June 11, 2026 15:39
gsxdsm added a commit that referenced this pull request Jun 11, 2026
Address PR #1591 feedback by separating workflow work item states from kinds in the runtime reference. The documented state list now matches WORKFLOW_WORK_ITEM_STATES, and recovery is documented as a kind.

Note: pre-existing failure in pnpm test:gate at packages/engine/src/__tests__/self-healing.test.ts not addressed by this PR feedback fix.
gsxdsm added a commit that referenced this pull request Jun 11, 2026
Address PR #1591 feedback by including the scheduler deletion guard in the documented workflow-owned merge verification set.
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch from 3a31499 to 3a4a6a4 Compare June 11, 2026 15:44
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s17-cutover-matrix branch 2 times, most recently from 74624f9 to 51057f7 Compare June 11, 2026 15:49
gsxdsm added a commit that referenced this pull request Jun 11, 2026
Address PR #1591 feedback by separating workflow work item states from kinds in the runtime reference. The documented state list now matches WORKFLOW_WORK_ITEM_STATES, and recovery is documented as a kind.

Note: pre-existing failure in pnpm test:gate at packages/engine/src/__tests__/self-healing.test.ts not addressed by this PR feedback fix.
gsxdsm added a commit that referenced this pull request Jun 11, 2026
Address PR #1591 feedback by including the scheduler deletion guard in the documented workflow-owned merge verification set.
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch from 3a4a6a4 to 518ab1a Compare June 11, 2026 15:49
gsxdsm added 4 commits June 11, 2026 08:51
Capture the workflow-owned merge stack repair pattern learned from resolving review feedback across dependent PRs, including the earliest-branch fix and rebase-forward workflow.
Address PR #1591 feedback by separating workflow work item states from kinds in the runtime reference. The documented state list now matches WORKFLOW_WORK_ITEM_STATES, and recovery is documented as a kind.

Note: pre-existing failure in pnpm test:gate at packages/engine/src/__tests__/self-healing.test.ts not addressed by this PR feedback fix.
Address PR #1591 feedback by including the scheduler deletion guard in the documented workflow-owned merge verification set.
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s17-cutover-matrix branch from 51057f7 to 2ce9a9f Compare June 11, 2026 15:51
@gsxdsm gsxdsm force-pushed the feature/workflow-owned-merge-s18-docs-settings-release branch from 518ab1a to ab59d72 Compare June 11, 2026 15:51
@stage-review

stage-review Bot commented Jun 16, 2026

Copy link
Copy Markdown

Ready to review this PR? Stage has broken it down into 4 individual chapters for you:

Title
1 Define core workflow work item concepts
2 Document workflow-owned merge runtime and architecture
3 Establish stacked PR feedback resolution patterns
4 Update testing guidance and release planning
Open in Stage

Chapters generated by Stage for commit ab59d72 on Jun 16, 2026 9:20am UTC.

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