Files

T

xingyue a5c09adae6 docs: add README.md to all 8 packages

Each README includes: package description, install instructions,
usage example, API overview, and (for templates) role/moderator flow.

Packages documented:
- @uncaged/workflow (core)
- @uncaged/cli-workflow (CLI)
- @uncaged/workflow-agent-cursor
- @uncaged/workflow-agent-hermes
- @uncaged/workflow-agent-llm
- @uncaged/workflow-template-develop
- @uncaged/workflow-template-solve-issue
- @uncaged/workflow-util-agent

2026-05-08 10:17:40 +08:00

1.7 KiB

Raw Blame History

@uncaged/workflow-template-solve-issue

Reference solve-issue workflow template: prepare a repo, delegate implementation to the develop workflow, then submit (e.g. open a PR).

createSolveIssueRun wires the developer role to workflowAsAgent("develop") by default; binding.overrides.developer wins if you pass one (for tests or custom hosts).

Install

bun add @uncaged/workflow-template-solve-issue @uncaged/workflow zod

In this monorepo: workspace:* for this package and @uncaged/workflow.

Usage

import { createSolveIssueRun, solveIssueWorkflowDefinition } from "@uncaged/workflow-template-solve-issue";

const run = createSolveIssueRun(binding, extract, llmProvider);

Roles

Role	Purpose
preparer	Set up context / repo state for the issue
developer	Implementation; default runs the registered `develop` workflow as a sub-agent
submitter	Finalize and submit the outcome (e.g. PR)

Also exported: preparerRole, developerRole, submitterRole and their Zod meta schemas, SolveIssueMeta, solveIssueRoles.

Moderator flow

Start → preparer
After preparer → developer
After developer → submitter
After submitter → END

API overview

Export	Description
`createSolveIssueRun`	Merges `developer` override with `workflowAsAgent("develop")`, then `createWorkflow`
`solveIssueWorkflowDefinition`	`description`, `roles`, `solveIssueModerator`
`solveIssueModerator`	Linear `Moderator<SolveIssueMeta>`
`buildSolveIssueDescriptor`	Descriptor helper for bundles
`SOLVE_ISSUE_WORKFLOW_DESCRIPTION`	Human-readable one-liner

1.7 KiB Raw Blame History