pi-skill-playbook 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -4
- package/docs/examples.md +38 -2
- package/package.json +1 -1
- package/samples/oss-maintenance-onboard.yml +22 -0
- package/samples/pi-oss-bootstrap-only.yml +43 -0
- package/samples/pi-oss-new.yml +91 -0
package/README.md
CHANGED
|
@@ -117,15 +117,26 @@ PLAYBOOK_OUTCOME: ready-for-prd
|
|
|
117
117
|
| `suggest` | Marker only suggests `/playbook:done` or `/playbook:choose` |
|
|
118
118
|
| `off` | No prompt injection or completion detection |
|
|
119
119
|
|
|
120
|
+
## Sample playbooks
|
|
121
|
+
|
|
122
|
+
| Playbook | File | When to use |
|
|
123
|
+
|---|---|---|
|
|
124
|
+
| Feature Development | `feature-development.yml` | Generic product work with standard `to-prd` / `to-issues` skills. Good default for non-OSS projects. |
|
|
125
|
+
| Pi OSS New Extension Delivery | `pi-oss-new.yml` | Full Pi OSS lane from idea through PR verify and release post. Uses `-for-oss` skills and vault maintenance skills. |
|
|
126
|
+
| Pi OSS Bootstrap Only | `pi-oss-bootstrap-only.yml` | Repo + vault bootstrap, then PRD and issue slicing only. Stops before implementation. |
|
|
127
|
+
| OSS Maintenance Onboarding | `oss-maintenance-onboard.yml` | Add a new OSS target to the Multica maintenance operating model. |
|
|
128
|
+
|
|
129
|
+
Copy one or more files from `samples/` into `.pi/playbooks/` in the target project. See [`docs/examples.md`](docs/examples.md) for copy-and-start steps.
|
|
130
|
+
|
|
120
131
|
## Package contents
|
|
121
132
|
|
|
122
133
|
```
|
|
123
134
|
pi-skill-playbook/
|
|
124
135
|
├── extensions/ Pi extension entry point
|
|
125
136
|
├── src/ Domain logic: validation, state, rendering, auto-advance
|
|
126
|
-
├── samples/ Example playbooks (
|
|
137
|
+
├── samples/ Example playbooks (generic + Pi OSS lane)
|
|
127
138
|
├── tests/ Node.js test suite
|
|
128
|
-
├── docs/
|
|
139
|
+
├── docs/ Examples and architecture decision records
|
|
129
140
|
├── LICENSE MIT
|
|
130
141
|
└── README.md
|
|
131
142
|
```
|
|
@@ -155,7 +166,7 @@ steps:
|
|
|
155
166
|
to: complete # "complete" ends the run
|
|
156
167
|
```
|
|
157
168
|
|
|
158
|
-
See [`samples/feature-development.yml`](samples/feature-development.yml) for a
|
|
169
|
+
See [`samples/feature-development.yml`](samples/feature-development.yml) for a generic example and [`samples/pi-oss-new.yml`](samples/pi-oss-new.yml) for the Pi OSS delivery lane.
|
|
159
170
|
|
|
160
171
|
## Development
|
|
161
172
|
|
|
@@ -182,13 +193,14 @@ Manual dispatch is also available from the Actions tab.
|
|
|
182
193
|
- Run state is local-only (`.pi/playbook-runs/`). No data leaves the machine.
|
|
183
194
|
- The extension does **not** inject system prompts for skill execution. It only adds a short playbook prompt describing the current step, valid outcomes, and expected marker format.
|
|
184
195
|
- No automatic file edits — the extension warns with a `.gitignore` snippet instead of modifying files.
|
|
185
|
-
-
|
|
196
|
+
- For vulnerability reporting, see [`SECURITY.md`](SECURITY.md).
|
|
186
197
|
|
|
187
198
|
## Links
|
|
188
199
|
|
|
189
200
|
- [npm package](https://www.npmjs.com/package/pi-skill-playbook)
|
|
190
201
|
- [GitHub repository](https://github.com/eiei114/pi-skill-playbook)
|
|
191
202
|
- [Pi coding agent](https://github.com/earendil-works/pi-coding-agent)
|
|
203
|
+
- [Roadmap](ROADMAP.md)
|
|
192
204
|
- [Architecture decisions](docs/adr/)
|
|
193
205
|
|
|
194
206
|
## License
|
package/docs/examples.md
CHANGED
|
@@ -1,11 +1,45 @@
|
|
|
1
1
|
# Examples
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Copy a sample into your project
|
|
4
4
|
|
|
5
|
-
Copy
|
|
5
|
+
Package samples ship under `samples/`. Copy the playbook that matches your lane into the target project's `.pi/playbooks/` folder:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
mkdir -p .pi/playbooks
|
|
9
|
+
|
|
10
|
+
# Generic feature development
|
|
11
|
+
cp node_modules/pi-skill-playbook/samples/feature-development.yml .pi/playbooks/
|
|
12
|
+
|
|
13
|
+
# Pi OSS delivery lane (idea -> PRD -> issues -> TDD -> review -> PR verify -> release post)
|
|
14
|
+
cp node_modules/pi-skill-playbook/samples/pi-oss-new.yml .pi/playbooks/
|
|
15
|
+
|
|
16
|
+
# Pi OSS bootstrap only (repo + vault setup -> PRD -> issues)
|
|
17
|
+
cp node_modules/pi-skill-playbook/samples/pi-oss-bootstrap-only.yml .pi/playbooks/
|
|
18
|
+
|
|
19
|
+
# Multica OSS maintenance onboarding
|
|
20
|
+
cp node_modules/pi-skill-playbook/samples/oss-maintenance-onboard.yml .pi/playbooks/
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Add run state to the target repo's `.gitignore`:
|
|
24
|
+
|
|
25
|
+
```gitignore
|
|
26
|
+
.pi/playbook-runs/
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Start a run
|
|
30
|
+
|
|
31
|
+
From the Pi TUI, list playbooks and start one with the selection UI:
|
|
6
32
|
|
|
7
33
|
```text
|
|
34
|
+
/playbook:list
|
|
8
35
|
/playbook:start
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
When multiple playbooks exist, Pi shows a selector with validation status for each file. The run id is generated automatically.
|
|
39
|
+
|
|
40
|
+
## Drive the workflow
|
|
41
|
+
|
|
42
|
+
```text
|
|
9
43
|
/skill:grill-with-docs <feature idea>
|
|
10
44
|
/playbook:done
|
|
11
45
|
/playbook:choose
|
|
@@ -16,3 +50,5 @@ Copy or create YAML playbooks in the target project under `.pi/playbooks/`, then
|
|
|
16
50
|
- `/playbook:resume` opens an active-run selector.
|
|
17
51
|
- `/playbook:choose` opens a selector for the current step's valid outcomes.
|
|
18
52
|
- `/playbook:cancel` selects an active run when needed and asks for confirmation before marking it cancelled.
|
|
53
|
+
|
|
54
|
+
For Pi OSS samples, run the skill named in the widget's command hint at each step. Single-outcome steps can auto-advance when the assistant emits a visible `PLAYBOOK_OUTCOME:` marker.
|
package/package.json
CHANGED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
version: 1
|
|
2
|
+
id: oss-maintenance-onboard
|
|
3
|
+
name: OSS Maintenance Onboarding
|
|
4
|
+
entry: onboard
|
|
5
|
+
autoAdvance: auto
|
|
6
|
+
|
|
7
|
+
skills:
|
|
8
|
+
oss-maintenance-onboarding:
|
|
9
|
+
role: entry
|
|
10
|
+
|
|
11
|
+
steps:
|
|
12
|
+
onboard:
|
|
13
|
+
primarySkill: oss-maintenance-onboarding
|
|
14
|
+
commandHint: "/skill:oss-maintenance-onboarding add this OSS target to Multica maintenance"
|
|
15
|
+
doneWhen:
|
|
16
|
+
- Target is registered in the vault maintenance control surface.
|
|
17
|
+
- Live Multica project is created or linked when requested.
|
|
18
|
+
- Controllers and Autopilot tracking are configured conservatively.
|
|
19
|
+
- Pilot issue verification notes are captured for the first maintenance slice.
|
|
20
|
+
transitions:
|
|
21
|
+
- outcome: complete
|
|
22
|
+
to: complete
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
version: 1
|
|
2
|
+
id: pi-oss-bootstrap-only
|
|
3
|
+
name: Pi OSS Bootstrap Only
|
|
4
|
+
entry: bootstrap
|
|
5
|
+
autoAdvance: auto
|
|
6
|
+
|
|
7
|
+
skills:
|
|
8
|
+
pi-oss-bootstrap:
|
|
9
|
+
role: entry
|
|
10
|
+
to-prd-for-oss:
|
|
11
|
+
role: internal
|
|
12
|
+
to-issues-for-oss:
|
|
13
|
+
role: internal
|
|
14
|
+
|
|
15
|
+
steps:
|
|
16
|
+
bootstrap:
|
|
17
|
+
primarySkill: pi-oss-bootstrap
|
|
18
|
+
commandHint: "/skill:pi-oss-bootstrap bootstrap a new Pi extension OSS project"
|
|
19
|
+
doneWhen:
|
|
20
|
+
- OSS repo exists under Projects/OSS/.
|
|
21
|
+
- Vault project folder exists under 4_Project/OSS/<project_key>/.
|
|
22
|
+
transitions:
|
|
23
|
+
- outcome: ready-for-prd
|
|
24
|
+
to: prd
|
|
25
|
+
|
|
26
|
+
prd:
|
|
27
|
+
primarySkill: to-prd-for-oss
|
|
28
|
+
commandHint: "/skill:to-prd-for-oss create PRD in 4_Project/<project>/Docs/"
|
|
29
|
+
doneWhen:
|
|
30
|
+
- PRD exists under the target OSS project Docs folder.
|
|
31
|
+
transitions:
|
|
32
|
+
- outcome: ready-for-issues
|
|
33
|
+
to: issues
|
|
34
|
+
|
|
35
|
+
issues:
|
|
36
|
+
primarySkill: to-issues-for-oss
|
|
37
|
+
commandHint: "/skill:to-issues-for-oss break PRD into tracer-bullet issues"
|
|
38
|
+
doneWhen:
|
|
39
|
+
- Issue files exist under 4_Project/<project>/Issues/.
|
|
40
|
+
- Issues are independently grabbable.
|
|
41
|
+
transitions:
|
|
42
|
+
- outcome: complete
|
|
43
|
+
to: complete
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
version: 1
|
|
2
|
+
id: pi-oss-new
|
|
3
|
+
name: Pi OSS New Extension Delivery
|
|
4
|
+
entry: grill
|
|
5
|
+
autoAdvance: auto
|
|
6
|
+
|
|
7
|
+
skills:
|
|
8
|
+
grill-with-docs:
|
|
9
|
+
role: entry
|
|
10
|
+
to-prd-for-oss:
|
|
11
|
+
role: internal
|
|
12
|
+
to-issues-for-oss:
|
|
13
|
+
role: internal
|
|
14
|
+
tdd:
|
|
15
|
+
role: internal
|
|
16
|
+
review:
|
|
17
|
+
role: internal
|
|
18
|
+
pi-extension-pr-verify:
|
|
19
|
+
role: internal
|
|
20
|
+
x-release-post:
|
|
21
|
+
role: internal
|
|
22
|
+
|
|
23
|
+
steps:
|
|
24
|
+
grill:
|
|
25
|
+
primarySkill: grill-with-docs
|
|
26
|
+
commandHint: "/skill:grill-with-docs <Pi OSS extension idea>"
|
|
27
|
+
doneWhen:
|
|
28
|
+
- Problem boundary is clear for the new Pi OSS project.
|
|
29
|
+
- Key terminology and repo layout are resolved.
|
|
30
|
+
transitions:
|
|
31
|
+
- outcome: ready-for-prd
|
|
32
|
+
to: prd
|
|
33
|
+
|
|
34
|
+
prd:
|
|
35
|
+
primarySkill: to-prd-for-oss
|
|
36
|
+
commandHint: "/skill:to-prd-for-oss create PRD in 4_Project/<project>/Docs/"
|
|
37
|
+
doneWhen:
|
|
38
|
+
- PRD exists under the target OSS project Docs folder.
|
|
39
|
+
transitions:
|
|
40
|
+
- outcome: ready-for-issues
|
|
41
|
+
to: issues
|
|
42
|
+
|
|
43
|
+
issues:
|
|
44
|
+
primarySkill: to-issues-for-oss
|
|
45
|
+
commandHint: "/skill:to-issues-for-oss break PRD into tracer-bullet issues"
|
|
46
|
+
doneWhen:
|
|
47
|
+
- Issue files exist under 4_Project/<project>/Issues/.
|
|
48
|
+
- Issues are independently grabbable.
|
|
49
|
+
transitions:
|
|
50
|
+
- outcome: ready-for-implementation
|
|
51
|
+
to: implement
|
|
52
|
+
|
|
53
|
+
implement:
|
|
54
|
+
primarySkill: tdd
|
|
55
|
+
commandHint: "/skill:tdd implement the next OSS issue"
|
|
56
|
+
doneWhen:
|
|
57
|
+
- Tests pass.
|
|
58
|
+
- Implementation is complete for the current slice.
|
|
59
|
+
transitions:
|
|
60
|
+
- outcome: ready-for-review
|
|
61
|
+
to: review
|
|
62
|
+
|
|
63
|
+
review:
|
|
64
|
+
primarySkill: review
|
|
65
|
+
commandHint: "/skill:review review this branch against the plan"
|
|
66
|
+
doneWhen:
|
|
67
|
+
- Standards and spec review results are known.
|
|
68
|
+
transitions:
|
|
69
|
+
- outcome: pass
|
|
70
|
+
to: pr-verify
|
|
71
|
+
- outcome: fail
|
|
72
|
+
to: implement
|
|
73
|
+
|
|
74
|
+
pr-verify:
|
|
75
|
+
primarySkill: pi-extension-pr-verify
|
|
76
|
+
commandHint: "/skill:pi-extension-pr-verify verify the PR locally"
|
|
77
|
+
doneWhen:
|
|
78
|
+
- PR worktree is set up and automated checks pass.
|
|
79
|
+
- Manual Pi TUI verification checklist is complete.
|
|
80
|
+
transitions:
|
|
81
|
+
- outcome: ready-for-release
|
|
82
|
+
to: release-post
|
|
83
|
+
|
|
84
|
+
release-post:
|
|
85
|
+
primarySkill: x-release-post
|
|
86
|
+
commandHint: "/skill:x-release-post draft X release announcement"
|
|
87
|
+
doneWhen:
|
|
88
|
+
- English and Japanese release post drafts are saved.
|
|
89
|
+
transitions:
|
|
90
|
+
- outcome: complete
|
|
91
|
+
to: complete
|