-
Notifications
You must be signed in to change notification settings - Fork 0
Start new v0.11.0 development #32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
3b0fb9a
1454ccb
1e46f55
2e7df1e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| --- | ||
| name: "OPSX: Apply" | ||
| description: Implement tasks from an OpenSpec change (Experimental) | ||
| category: Workflow | ||
| tags: [workflow, artifacts, experimental] | ||
| --- | ||
|
|
||
| Implement tasks from an OpenSpec change. | ||
|
|
||
| **Input**: Optionally specify a change name (e.g., `/opsx:apply add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes. | ||
|
|
||
| **Steps** | ||
|
|
||
| 1. **Select the change** | ||
|
|
||
| If a name is provided, use it. Otherwise: | ||
| - Infer from conversation context if the user mentioned a change | ||
| - Auto-select if only one active change exists | ||
| - If ambiguous, run `openspec list --json` to get available changes and use the **AskUserQuestion tool** to let the user select | ||
|
|
||
| Always announce: "Using change: <name>" and how to override (e.g., `/opsx:apply <other>`). | ||
|
|
||
| 2. **Check status to understand the schema** | ||
| ```bash | ||
| openspec status --change "<name>" --json | ||
| ``` | ||
| Parse the JSON to understand: | ||
| - `schemaName`: The workflow being used (e.g., "spec-driven") | ||
| - Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others) | ||
|
|
||
| 3. **Get apply instructions** | ||
|
|
||
| ```bash | ||
| openspec instructions apply --change "<name>" --json | ||
| ``` | ||
|
|
||
| This returns: | ||
| - Context file paths (varies by schema) | ||
| - Progress (total, complete, remaining) | ||
| - Task list with status | ||
| - Dynamic instruction based on current state | ||
|
|
||
| **Handle states:** | ||
| - If `state: "blocked"` (missing artifacts): show message, suggest using `/opsx:continue` | ||
| - If `state: "all_done"`: congratulate, suggest archive | ||
| - Otherwise: proceed to implementation | ||
|
|
||
| 4. **Read context files** | ||
|
|
||
| Read the files listed in `contextFiles` from the apply instructions output. | ||
| The files depend on the schema being used: | ||
| - **spec-driven**: proposal, specs, design, tasks | ||
| - Other schemas: follow the contextFiles from CLI output | ||
|
|
||
| 5. **Show current progress** | ||
|
|
||
| Display: | ||
| - Schema being used | ||
| - Progress: "N/M tasks complete" | ||
| - Remaining tasks overview | ||
| - Dynamic instruction from CLI | ||
|
|
||
| 6. **Implement tasks (loop until done or blocked)** | ||
|
|
||
| For each pending task: | ||
| - Show which task is being worked on | ||
| - Make the code changes required | ||
| - Keep changes minimal and focused | ||
| - Mark task complete in the tasks file: `- [ ]` → `- [x]` | ||
| - Continue to next task | ||
|
|
||
| **Pause if:** | ||
| - Task is unclear → ask for clarification | ||
| - Implementation reveals a design issue → suggest updating artifacts | ||
| - Error or blocker encountered → report and wait for guidance | ||
| - User interrupts | ||
|
|
||
| 7. **On completion or pause, show status** | ||
|
|
||
| Display: | ||
| - Tasks completed this session | ||
| - Overall progress: "N/M tasks complete" | ||
| - If all done: suggest archive | ||
| - If paused: explain why and wait for guidance | ||
|
|
||
| **Output During Implementation** | ||
|
|
||
| ``` | ||
| ## Implementing: <change-name> (schema: <schema-name>) | ||
| Working on task 3/7: <task description> | ||
| [...implementation happening...] | ||
| ✓ Task complete | ||
| Working on task 4/7: <task description> | ||
| [...implementation happening...] | ||
| ✓ Task complete | ||
| ``` | ||
|
|
||
| **Output On Completion** | ||
|
|
||
| ``` | ||
| ## Implementation Complete | ||
| **Change:** <change-name> | ||
| **Schema:** <schema-name> | ||
| **Progress:** 7/7 tasks complete ✓ | ||
| ### Completed This Session | ||
| - [x] Task 1 | ||
| - [x] Task 2 | ||
| ... | ||
| All tasks complete! You can archive this change with `/opsx:archive`. | ||
| ``` | ||
|
|
||
| **Output On Pause (Issue Encountered)** | ||
|
|
||
| ``` | ||
| ## Implementation Paused | ||
| **Change:** <change-name> | ||
| **Schema:** <schema-name> | ||
| **Progress:** 4/7 tasks complete | ||
| ### Issue Encountered | ||
| <description of the issue> | ||
| **Options:** | ||
| 1. <option 1> | ||
| 2. <option 2> | ||
| 3. Other approach | ||
| What would you like to do? | ||
| ``` | ||
|
|
||
| **Guardrails** | ||
| - Keep going through tasks until done or blocked | ||
| - Always read context files before starting (from the apply instructions output) | ||
| - If task is ambiguous, pause and ask before implementing | ||
| - If implementation reveals issues, pause and suggest artifact updates | ||
| - Keep code changes minimal and scoped to each task | ||
| - Update task checkbox immediately after completing each task | ||
| - Pause on errors, blockers, or unclear requirements - don't guess | ||
| - Use contextFiles from CLI output, don't assume specific file names | ||
|
|
||
| **Fluid Workflow Integration** | ||
|
|
||
| This skill supports the "actions on a change" model: | ||
|
|
||
| - **Can be invoked anytime**: Before all artifacts are done (if tasks exist), after partial implementation, interleaved with other actions | ||
| - **Allows artifact updates**: If implementation reveals design issues, suggest updating artifacts - not phase-locked, work fluidly | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| --- | ||
| name: "OPSX: Archive" | ||
| description: Archive a completed change in the experimental workflow | ||
| category: Workflow | ||
| tags: [workflow, archive, experimental] | ||
| --- | ||
|
|
||
| Archive a completed change in the experimental workflow. | ||
|
|
||
| **Input**: Optionally specify a change name after `/opsx:archive` (e.g., `/opsx:archive add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes. | ||
|
|
||
| **Steps** | ||
|
|
||
| 1. **If no change name provided, prompt for selection** | ||
|
|
||
| Run `openspec list --json` to get available changes. Use the **AskUserQuestion tool** to let the user select. | ||
|
|
||
| Show only active changes (not already archived). | ||
| Include the schema used for each change if available. | ||
|
|
||
| **IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose. | ||
|
|
||
| 2. **Check artifact completion status** | ||
|
|
||
| Run `openspec status --change "<name>" --json` to check artifact completion. | ||
|
|
||
| Parse the JSON to understand: | ||
| - `schemaName`: The workflow being used | ||
| - `artifacts`: List of artifacts with their status (`done` or other) | ||
|
|
||
| **If any artifacts are not `done`:** | ||
| - Display warning listing incomplete artifacts | ||
| - Prompt user for confirmation to continue | ||
| - Proceed if user confirms | ||
|
|
||
| 3. **Check task completion status** | ||
|
|
||
| Read the tasks file (typically `tasks.md`) to check for incomplete tasks. | ||
|
|
||
| Count tasks marked with `- [ ]` (incomplete) vs `- [x]` (complete). | ||
|
|
||
| **If incomplete tasks found:** | ||
| - Display warning showing count of incomplete tasks | ||
| - Prompt user for confirmation to continue | ||
| - Proceed if user confirms | ||
|
|
||
| **If no tasks file exists:** Proceed without task-related warning. | ||
|
|
||
| 4. **Assess delta spec sync state** | ||
|
|
||
| Check for delta specs at `openspec/changes/<name>/specs/`. If none exist, proceed without sync prompt. | ||
|
|
||
| **If delta specs exist:** | ||
| - Compare each delta spec with its corresponding main spec at `openspec/specs/<capability>/spec.md` | ||
| - Determine what changes would be applied (adds, modifications, removals, renames) | ||
| - Show a combined summary before prompting | ||
|
|
||
| **Prompt options:** | ||
| - If changes needed: "Sync now (recommended)", "Archive without syncing" | ||
| - If already synced: "Archive now", "Sync anyway", "Cancel" | ||
|
|
||
| If user chooses sync, execute `/opsx:sync` logic. Proceed to archive regardless of choice. | ||
|
|
||
| 5. **Perform the archive** | ||
|
|
||
| Create the archive directory if it doesn't exist: | ||
| ```bash | ||
| mkdir -p openspec/changes/archive | ||
| ``` | ||
|
|
||
| Generate target name using current date: `YYYY-MM-DD-<change-name>` | ||
|
|
||
| **Check if target already exists:** | ||
| - If yes: Fail with error, suggest renaming existing archive or using different date | ||
| - If no: Move the change directory to archive | ||
|
|
||
| ```bash | ||
| mv openspec/changes/<name> openspec/changes/archive/YYYY-MM-DD-<name> | ||
| ``` | ||
|
|
||
| 6. **Display summary** | ||
|
|
||
| Show archive completion summary including: | ||
| - Change name | ||
| - Schema that was used | ||
| - Archive location | ||
| - Spec sync status (synced / sync skipped / no delta specs) | ||
| - Note about any warnings (incomplete artifacts/tasks) | ||
|
|
||
| **Output On Success** | ||
|
|
||
| ``` | ||
| ## Archive Complete | ||
|
|
||
| **Change:** <change-name> | ||
| **Schema:** <schema-name> | ||
| **Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/ | ||
| **Specs:** ✓ Synced to main specs | ||
|
|
||
| All artifacts complete. All tasks complete. | ||
| ``` | ||
|
Comment on lines
+92
to
+101
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win Use These success/error transcripts are non-code content, so bare fences violate the repo markdown rule. Please convert them to Also applies to: 105-114, 118-132, 136-148 🤖 Prompt for AI AgentsSource: Coding guidelines |
||
|
|
||
| **Output On Success (No Delta Specs)** | ||
|
|
||
| ``` | ||
| ## Archive Complete | ||
|
|
||
| **Change:** <change-name> | ||
| **Schema:** <schema-name> | ||
| **Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/ | ||
| **Specs:** No delta specs | ||
|
|
||
| All artifacts complete. All tasks complete. | ||
| ``` | ||
|
|
||
| **Output On Success With Warnings** | ||
|
|
||
| ``` | ||
| ## Archive Complete (with warnings) | ||
|
|
||
| **Change:** <change-name> | ||
| **Schema:** <schema-name> | ||
| **Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/ | ||
| **Specs:** Sync skipped (user chose to skip) | ||
|
|
||
| **Warnings:** | ||
| - Archived with 2 incomplete artifacts | ||
| - Archived with 3 incomplete tasks | ||
| - Delta spec sync was skipped (user chose to skip) | ||
|
|
||
| Review the archive if this was not intentional. | ||
| ``` | ||
|
|
||
| **Output On Error (Archive Exists)** | ||
|
|
||
| ``` | ||
| ## Archive Failed | ||
|
|
||
| **Change:** <change-name> | ||
| **Target:** openspec/changes/archive/YYYY-MM-DD-<name>/ | ||
|
|
||
| Target archive directory already exists. | ||
|
|
||
| **Options:** | ||
| 1. Rename the existing archive | ||
| 2. Delete the existing archive if it's a duplicate | ||
| 3. Wait until a different date to archive | ||
| ``` | ||
|
|
||
| **Guardrails** | ||
| - Always prompt for change selection if not provided | ||
| - Use artifact graph (openspec status --json) for completion checking | ||
| - Don't block archive on warnings - just inform and confirm | ||
| - Preserve .openspec.yaml when moving to archive (it moves with the directory) | ||
| - Show clear summary of what happened | ||
| - If sync is requested, use /opsx:sync approach (agent-driven) | ||
| - If delta specs exist, always run the sync assessment and show the combined summary before prompting | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win
Use
textfences for the output examples.These transcript-style blocks are non-code content, so bare fences violate the repo markdown rule. Please convert them to
textfences throughout this section. As per coding guidelines, docs must tag non-code fences withtext.Also applies to: 102-115, 119-135
🤖 Prompt for AI Agents
Source: Coding guidelines