plan-generator

Files (1)

• SKILL.md

SKILL.md (first lines)

# Plan Generator

Generates a high-level implementation plan from ticket requirements and research findings. Surfaces decision points, alternatives, risks, and pivot triggers. Iterates with human feedback until approved.

## Configuration

Uses the **production API** by default. No configuration needed for read operations.

**Defaults (no setup required):**

- API URL: `https://api-gateway-856475788601.us-central1.run.app`
- Read-only endpoints at `/public/*` require no authentication

**For write operations** (state transitions), set:

```bash
export PIPELINE_API_KEY="..."  # Get from GCP Secret Manager or ask admin
```

**Local directory for working artifacts:**

```bash
PIPELINE_DIR="${PIPELINE_DIR:-$HOME/repos/ticket-to-pr-pipeline}"
```

## Prerequisites

- Ticket exists in API (via `ticket-intake`)
- `research-report.md` exists locally as working artifact
- Human has reviewed and approved the research
- `PIPELINE_API_KEY` set for write operations (get from GCP Secret Manager or ask admin)

## Workflow

### 0. Verify Pipeline Ticket Exists

Before proceeding, confirm a ticket exists in the pipeline API. If not, run `ticket-intake` first.

```typescript
const ticket = await client.getTicket(ticketId)
if (!ticket) {
  throw new Error('❌ No pipeline ticket found. Run ticket-intake first to register this ticket in the pipeline API.')
}
```

If no `ticketId` is available, search by Notion page ID or list recent tickets:

```typescript
const ticket = await client.findByNotionId(notionPageId)
if (!ticket) {
  console.error('❌ No pipeline ticket found for this Notion page. Run ticket-intake first.')
  process.exit(1)
}
const ticketId = ticket.id
```

### 1. Load Context

Get ticket data via the Pipeline API and read local research artifact:

```typescript
import { PipelineClient } from '@pipeline/client'

const client = new PipelineClient({
  apiUrl: process.env.PIPELINE_API_URL || 'https://api-gateway-856475788601.us-central1.run.app',
  agentId: process.env.AGENT_ID ?? 'plan-generator',
})

// Get ticket data from API
const ticket = await client.getTicket(ticketId)

// Transition to PLANNING state
await client.transitionState(ticketId, 'PLANNING', 'Starting plan generation')

// Read local research artifact
// research-report.md in working directory
```

Extract from ticket:

- Title and description
- Acceptance criteria
- Affected files/areas

Extract from research-report.md:

- Recommended patterns
- Similar implementations found
- Risks identified
- Open questions

### 2. Generate High-Level Plan

Create the plan following this structure:

```markdown
# Implementation Plan: {Ticket Title}

## Goal

One sentence describing what we're building and why.

## Proposed Approach

High-level description of the solution (2-3 paragraphs max).

## Decision Points

### Decision 1: {Title}

**Options:**

- **Option A:** {description}
  - Pros: ...
  - Cons: ...
- **Option B:** {description}
  - Pros: ...
  - Cons: ...

From DrJKL/ticket-to-pr-pipeline, MIT.

More from DrJKL/ticket-to-pr-pipeline