github-delivery-os 1.2.2 → 1.3.1
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/.claude/skills/delivery-ops/SKILL.md +58 -1
- package/README.md +21 -6
- package/package.json +1 -1
- package/src/install.js +27 -4
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: delivery-ops
|
|
3
|
-
description: Operate a repo that has GitHub Delivery OS installed — create sprint/production-release/QA-request/bug issues that actually trigger its automation, comment as an approver in phrasing its workflows recognize,
|
|
3
|
+
description: Operate a repo that has GitHub Delivery OS installed — create sprint/production-release/QA-request/bug issues that actually trigger its automation, comment as an approver in phrasing its workflows recognize, check status (labels, latest comments, burn-down), and run autonomous task tracking (identify tasks/bugs, group them into phases via sprints, maintain a roadmap issue, update status, comment, and close as work progresses). Targets a specific repo via --repo; defaults to the current repo if this skill was installed into it and none is named. Use when asked to create a sprint, request a release, approve/decline a release, check release or sprint status, track/file a task or bug found during work, plan or check a roadmap/phase, or demo/test Delivery OS against a given repo.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Operate Delivery OS
|
|
@@ -30,6 +30,8 @@ Before creating anything that depends on configuration, check the target repo ac
|
|
|
30
30
|
|
|
31
31
|
**Show the constructed title, body, and labels before actually creating the issue** — this is a real, visible action in someone else's repo, not a preview in this conversation. Get confirmation on the content, not just the target repo, before calling `gh issue create`.
|
|
32
32
|
|
|
33
|
+
This confirm-first default is for issues created **on explicit request** ("file a bug for this", "create a sprint"). The "Autonomous tracking" section below describes a *different* mode — noticing and filing work on its own during a session — and overrides this default there: act first, confirm after, per its own "Confirm only when unsure" rule. Don't apply both rules to the same action.
|
|
34
|
+
|
|
33
35
|
**Sprint Planning** — triggers `sprint-child-creator` (one child issue per feature line, each labeled `sprint-active`, on open):
|
|
34
36
|
- Title **must contain** the literal string `SPRINT -`, e.g. `SPRINT - Sprint 14`
|
|
35
37
|
- Labels: `sprint`, `planning`
|
|
@@ -163,6 +165,61 @@ gh issue close <number> --repo <owner>/<repo>
|
|
|
163
165
|
|
|
164
166
|
`auto-close-sprint` fires on close, re-reads every `sprint-active` issue whose body contains `Parent Sprint: #<N>`, recomputes progress, and rewrites the sprint issue's `## 🚦 Sprint Status` section. At 100% it also closes the sprint issue itself and posts a completion comment. Re-check the sprint issue's body afterward to see the update — it happens as a side effect of closing the child, not as a response visible on the child issue itself.
|
|
165
167
|
|
|
168
|
+
## Autonomous tracking (identify → file → update → close)
|
|
169
|
+
|
|
170
|
+
Beyond filing one issue on request, this skill can run a piece of work's whole lifecycle: notice it, classify it, file it, keep it in sync as work happens, and close it out. GitHub issues are the only source of truth — there is no local state, and nothing here persists across sessions except what's written back to the repo.
|
|
171
|
+
|
|
172
|
+
### Confirm only when unsure
|
|
173
|
+
|
|
174
|
+
Don't ask before every action — that defeats the point. Act, then say so in one line of the conversation ("Filed #23: TASK - ...", "Updated #17 to In Progress", "Closed #17 — acceptance criteria met"). Every GitHub-visible action gets that line, regardless of confidence, so nothing happens invisibly even when nothing was asked first.
|
|
175
|
+
|
|
176
|
+
Ask first only when something is genuinely ambiguous:
|
|
177
|
+
- Unclear whether this is actually a new item or an update to an existing open issue
|
|
178
|
+
- Unclear which category it is (Task vs. Bug vs. part of a Sprint)
|
|
179
|
+
- Unclear whether it's actually done (e.g. a PR opened but CI hasn't run, or the acceptance criteria are only partly met)
|
|
180
|
+
|
|
181
|
+
A clear-cut case — an obvious bug just reproduced, a PR that visibly closes an issue's acceptance criteria — doesn't need a question, just the confirmation line afterward.
|
|
182
|
+
|
|
183
|
+
### Classifying a candidate
|
|
184
|
+
|
|
185
|
+
- Bug reproduced or reported while working → **Bug Report**
|
|
186
|
+
- Scoped, actionable follow-up (including things deliberately deferred, like [Phaneroo/github-delivery-operating-system#12](https://github.com/Phaneroo/github-delivery-operating-system/issues/12)) → **Task**
|
|
187
|
+
- A batch of related work with a start/end date → **Sprint** (see "Phases" below)
|
|
188
|
+
- Something that blocks a release or needs sign-off → **Production Release** / **QA Request** (rare mid-session; only when it's actually that, not just "important")
|
|
189
|
+
|
|
190
|
+
### Phases = Sprints, roadmap = one tracking issue
|
|
191
|
+
|
|
192
|
+
No new issue type needed — reuse what's already documented above:
|
|
193
|
+
- **A phase is a Sprint Planning issue.** Group Task issues under it exactly the way `sprint-child-creator` does: each child's body contains `Parent Sprint: #<N>`. This keeps the existing burn-down and auto-close automation working even though Claude, not a human, opened the children.
|
|
194
|
+
- **A roadmap is one persistent issue** that lists phases/sprints and their state. Title it `ROADMAP - <project/area>`. No labels or automation attach to it — Claude keeps its body current with `gh issue edit --body-file`, the same rewrite pattern `auto-close-sprint` uses for a sprint's `## 🚦 Sprint Status` section, just done by Claude on request or after a phase's state changes rather than by a workflow.
|
|
195
|
+
|
|
196
|
+
### Reconcile by querying, never by remembering
|
|
197
|
+
|
|
198
|
+
Don't rely on recalling an issue number from earlier in the conversation, and never assume it's still accurate after a gap. Before updating or closing something, requery — by keyword search, not just by label, since a filed issue may carry no label at all (labels like `task`/`bug` only exist once `Setup Labels` has been run for that repo; see the pre-flight check) or may be a Bug/Sprint-child/QA item instead of a Task:
|
|
199
|
+
|
|
200
|
+
```
|
|
201
|
+
gh issue list --repo <owner>/<repo> --state open --search "<keywords from the work>"
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
Narrow with `--label task` (or `bug`, `sprint-active`, `qa-request`) only once the category is known and the target repo actually has that label — don't assume `--label task` alone finds everything relevant.
|
|
205
|
+
|
|
206
|
+
This is also what makes picking work back up in a *new* session possible without any local memory — the issue list itself is the state.
|
|
207
|
+
|
|
208
|
+
### Keeping a Task issue in sync
|
|
209
|
+
|
|
210
|
+
The `### Status` field in the Task template body is the thing to keep current:
|
|
211
|
+
- `Backlog` → `In Progress` when work actually starts on it
|
|
212
|
+
- → `Ready for Review` when a PR opens against it
|
|
213
|
+
- → `Done` right before closing
|
|
214
|
+
|
|
215
|
+
To edit just that field: `gh issue view <number> --repo <owner>/<repo> --json body -q .body`, replace the line under `### Status` with the new value, then `gh issue edit <number> --repo <owner>/<repo> --body-file <file>`. Post a comment alongside any status change that isn't self-explanatory from the status alone (blocked and why, PR link, what shipped) — `gh issue comment <number> --repo <owner>/<repo> --body "<update>"`.
|
|
216
|
+
|
|
217
|
+
Close with `gh issue close <number> --repo <owner>/<repo> --comment "<summary of what was done>"` once the acceptance criteria are actually met — quote which ones, don't just say "done."
|
|
218
|
+
|
|
219
|
+
### Known limitation
|
|
220
|
+
|
|
221
|
+
This only tracks what happens while a Claude session is actively working — nothing reconciles state that changes in the background (a human merges a PR or closes an issue manually with no session running). That gap is tracked as its own deferred item rather than solved here: [Phaneroo/github-delivery-operating-system#12](https://github.com/Phaneroo/github-delivery-operating-system/issues/12). Mitigate it by always reconciling via `gh issue list` at the start of relevant work (see above) rather than trusting anything remembered from earlier.
|
|
222
|
+
|
|
166
223
|
## Finding things
|
|
167
224
|
|
|
168
225
|
When there's no issue number in hand yet:
|
package/README.md
CHANGED
|
@@ -61,6 +61,19 @@ npx github-delivery-os uninstall --dry-run . # Preview (no changes)
|
|
|
61
61
|
|
|
62
62
|
`status` also checks npm for a newer release and tells you if you're behind (e.g. `⬆️ Update available: 1.0.3 → 1.1.0`), along with the exact command to update. That check is silent and non-fatal if you're offline — use `--offline` to skip it outright (e.g. in CI).
|
|
63
63
|
|
|
64
|
+
**Command variations — which one to run when:**
|
|
65
|
+
|
|
66
|
+
| Command | When to run it |
|
|
67
|
+
|---------|-----------------|
|
|
68
|
+
| `npx github-delivery-os install --with-templates .` | First install of Delivery OS in a repo without Claude Code — workflows + issue templates. The default recommendation above. |
|
|
69
|
+
| `npx github-delivery-os install --with-templates --with-labels .` | Same, plus creating all required labels immediately via `gh` CLI — skips the manual "Actions → Setup Labels → Run workflow" step. Needs `gh auth`. |
|
|
70
|
+
| `npx github-delivery-os install --with-templates --with-skill .` | You (or your team) will operate this repo's Delivery OS from [Claude Code](https://claude.com/claude-code) — adds the `delivery-ops` skill so issues/comments/status checks can be done in plain language. |
|
|
71
|
+
| `npx github-delivery-os install --with-templates --with-labels --with-skill .` | Everything at once — the fastest path to a fully working, Claude-Code-operable install in one command. |
|
|
72
|
+
| `npx github-delivery-os install --with-templates --with-skill --dry-run .` | Preview any of the above combinations first — prints what would be created without writing anything. Combine with any other flags. |
|
|
73
|
+
| `npx github-delivery-os install --with-templates --with-skill --overwrite .` | Updating an existing install to the latest release, or retroactively adding `--with-templates`/`--with-skill` to a repo that skipped them originally. **Only** command here that replaces existing files — everything above is always skip-existing/safe. |
|
|
74
|
+
| `npx github-delivery-os status .` | Not sure what's currently installed, whether it's up to date, or whether a workflow is broken (e.g. a required script silently missing). Safe, read-only. |
|
|
75
|
+
| `npx github-delivery-os uninstall --with-templates --with-skill .` | Removing Delivery OS entirely — workflows, scripts, templates, and the skill. Omit either flag to keep that part (both are kept by default). |
|
|
76
|
+
|
|
64
77
|
**What gets installed:**
|
|
65
78
|
|
|
66
79
|
| Workflow | Trigger | Purpose |
|
|
@@ -77,7 +90,7 @@ Workflows and templates are **copied directly** into your repo. No `workflow_cal
|
|
|
77
90
|
|
|
78
91
|
Installing via `npx github-delivery-os` (not the `scripts/install.sh` clone path) also writes `.github/delivery-os.json`, a small manifest recording the installed version — this is what powers the update check in `status`. It's only written when the files it describes are actually current (a fresh install, or `--overwrite`); a skip-mode install over existing files leaves it untouched rather than claiming a version that isn't really on disk. `uninstall` removes it.
|
|
79
92
|
|
|
80
|
-
With `--with-skill`, a `.claude/skills/delivery-ops/SKILL.md` file is also written — a Claude Code skill scoped to this repo, so anyone working here with Claude Code can create issues that correctly trigger the workflows above, comment as an approver,
|
|
93
|
+
With `--with-skill`, a `.claude/skills/delivery-ops/SKILL.md` file is also written — a Claude Code skill scoped to this repo, so anyone working here with Claude Code can create issues that correctly trigger the workflows above, comment as an approver, check status, and run autonomous task tracking (identify and file tasks/bugs, group them into phases via sprints, maintain a roadmap issue, and update/close issues as work progresses) without knowing the underlying `gh` commands or issue-body formats by heart. It's opt-in and retroactive: `--with-skill` on any later `install` call adds it if it isn't there yet.
|
|
81
94
|
|
|
82
95
|
---
|
|
83
96
|
|
|
@@ -110,6 +123,8 @@ Installing with `--with-skill` drops a `.claude/skills/delivery-ops/SKILL.md` sk
|
|
|
110
123
|
|
|
111
124
|
Before doing anything, it checks the target repo: confirms Delivery OS is actually installed, that `Setup Labels` has been run, and that `RELEASE_APPROVER` / `QA_APPROVER` / `QA_ASSIGNEES` are configured — flagging (or offering to fix) gaps instead of silently creating an issue that does nothing. It also always shows the constructed title/body/labels or comment text for confirmation before creating or posting for real, since these are visible actions in the repo's activity, not a local preview.
|
|
112
125
|
|
|
126
|
+
It can also run the full lifecycle of a piece of work on its own: notice something worth tracking, classify it, file it, keep its status/comments in sync as work happens, and close it out — acting without asking when the outcome is clear (always posting a one-line notice in the conversation so nothing happens invisibly), and asking first only when the classification or "is this actually done" is genuinely ambiguous. A "phase" is just a Sprint Planning issue; a "roadmap" is one persistent issue Claude keeps rewritten with each phase's state — no new issue types or automation involved.
|
|
127
|
+
|
|
113
128
|
### Create a sprint
|
|
114
129
|
1. Ask: *"Create a sprint called Sprint 14 for \<goal>, running \<start> to \<end>, with features: \<one per line>"*
|
|
115
130
|
2. It opens an issue titled `SPRINT - Sprint 14`, labeled `sprint` + `planning`, with `### Sprint Name` / `Start` / `End` / `Goal` / `Features (One Per Line)` / `Approved` fields filled in.
|
|
@@ -153,28 +168,28 @@ See [How To](docs/how-to.md) for the underlying workflows this drives, field by
|
|
|
153
168
|
|
|
154
169
|
### Example: filing a bug and a task, step by step
|
|
155
170
|
|
|
156
|
-
|
|
171
|
+
Illustrative walkthrough against `acme/storefront`, a repo with Delivery OS installed (same example repo used in the full walkthrough below).
|
|
157
172
|
|
|
158
173
|
**Filing the bug:**
|
|
159
174
|
|
|
160
175
|
1. In Claude Code, inside (or pointed at, via `--repo`) the target repo, describe the bug in plain language:
|
|
161
|
-
> *File a bug on
|
|
176
|
+
> *File a bug on acme/storefront — the order request form submits with an empty phone number, severity high. Steps: fill in the form, leave phone blank, submit. Expected: should block submission. Actual: submits anyway, so there's no way to contact the customer. Tested on Chrome, desktop, production.*
|
|
162
177
|
2. Claude pre-flights the repo — confirms Delivery OS is installed and the `bug`/`qa` labels exist.
|
|
163
178
|
3. Claude shows the exact issue it's about to create before doing anything:
|
|
164
179
|
- Title: `[BUG] Order request form submits with empty phone number`
|
|
165
180
|
- Labels: `bug`, `qa`
|
|
166
181
|
- Body, field by field: `Platform(s) Affected` → Web, `Severity` → High, `Build / Version` → main (as deployed), `Bug Summary`, `Steps to Reproduce` (numbered), `Expected Result`, `Actual Result`, `Test Environment` → Chrome, desktop, production.
|
|
167
182
|
4. Confirm ("yes") when asked to create it.
|
|
168
|
-
5. Claude runs `gh issue create` and reports back the issue —
|
|
183
|
+
5. Claude runs `gh issue create` and reports back the issue — e.g. `acme/storefront#42`. Nothing else happens automatically; bug reports don't trigger a workflow, they're just labeled and tracked.
|
|
169
184
|
|
|
170
185
|
**Filing the follow-up task:**
|
|
171
186
|
|
|
172
187
|
1. Ask Claude to turn the bug into tracked work, referencing the bug's issue number:
|
|
173
|
-
> *Create a task to add phone number validation to the order form, owner @
|
|
188
|
+
> *Create a task to add phone number validation to the order form, owner @alex, priority P1, status Backlog, acceptance: form blocks submission until a valid phone number is entered. Link it to #42.*
|
|
174
189
|
2. Claude shows the constructed issue:
|
|
175
190
|
- Title: `TASK - Add phone number validation to order form`
|
|
176
191
|
- Labels: `task`
|
|
177
|
-
- Body: `Task Summary`, `Description` (references #
|
|
192
|
+
- Body: `Task Summary`, `Description` (references #42), `Owner` → @alex, `Priority` → P1 - High, `Status` → Backlog, `Acceptance Criteria`, `Artifacts / Links` → Related bug: #42.
|
|
178
193
|
3. Confirm ("yes") to create it.
|
|
179
194
|
4. Claude runs `gh issue create`. Same as the bug — no workflow trigger, just labeled and tracked, now linked back to the bug it addresses.
|
|
180
195
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "github-delivery-os",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.1",
|
|
4
4
|
"description": "A GitHub-native Delivery Governance Framework for structured sprint execution, QA review, and collaborative production release control.",
|
|
5
5
|
"main": "src/install.js",
|
|
6
6
|
"bin": {
|
package/src/install.js
CHANGED
|
@@ -460,6 +460,20 @@ function runInstall(options) {
|
|
|
460
460
|
console.log('=== Installation complete ===');
|
|
461
461
|
}
|
|
462
462
|
|
|
463
|
+
// runInstall only records a new manifest version when everything already
|
|
464
|
+
// installed actually gets touched this run (see the cleanInstall check
|
|
465
|
+
// there) — so a repo with templates and/or the skill already on disk needs
|
|
466
|
+
// --with-templates/--with-skill passed again on an update, not just
|
|
467
|
+
// --overwrite, or the recorded version never advances and `status` keeps
|
|
468
|
+
// suggesting the same command forever. Build the hint from what's actually
|
|
469
|
+
// on disk so it's never wrong.
|
|
470
|
+
function buildOverwriteCommand({ hasTemplates, hasSkill }) {
|
|
471
|
+
const flags = [hasTemplates ? '--with-templates' : null, hasSkill ? '--with-skill' : null, '--overwrite']
|
|
472
|
+
.filter(Boolean)
|
|
473
|
+
.join(' ');
|
|
474
|
+
return `npx github-delivery-os@latest install ${flags} .`;
|
|
475
|
+
}
|
|
476
|
+
|
|
463
477
|
const TEMPLATES = [
|
|
464
478
|
'config.yml',
|
|
465
479
|
'sprint_planning.yml',
|
|
@@ -518,7 +532,9 @@ async function runStatus(options) {
|
|
|
518
532
|
console.log(`Installed version: ${manifest.version}${installedOn}`);
|
|
519
533
|
} else {
|
|
520
534
|
console.log('Installed version: unknown (installed before version tracking was added)');
|
|
521
|
-
console.log(
|
|
535
|
+
console.log(
|
|
536
|
+
` Run: ${buildOverwriteCommand({ hasTemplates: installedTemplates.length > 0, hasSkill: skillInstalled })}`
|
|
537
|
+
);
|
|
522
538
|
}
|
|
523
539
|
|
|
524
540
|
if (checkUpdates) {
|
|
@@ -529,7 +545,9 @@ async function runStatus(options) {
|
|
|
529
545
|
console.log(`✓ Up to date (latest is ${latest})`);
|
|
530
546
|
} else if (manifest && manifest.version) {
|
|
531
547
|
console.log(`⬆️ Update available: ${manifest.version} → ${latest}`);
|
|
532
|
-
console.log(
|
|
548
|
+
console.log(
|
|
549
|
+
` Run: ${buildOverwriteCommand({ hasTemplates: installedTemplates.length > 0, hasSkill: skillInstalled })}`
|
|
550
|
+
);
|
|
533
551
|
} else {
|
|
534
552
|
console.log(`Latest published version: ${latest}`);
|
|
535
553
|
}
|
|
@@ -549,7 +567,9 @@ async function runStatus(options) {
|
|
|
549
567
|
console.log(` ${wf}.yml requires .github/scripts/${REQUIRED_SCRIPT_BY_WORKFLOW[wf]}.js, which is missing.`);
|
|
550
568
|
});
|
|
551
569
|
console.log(' That workflow will fail with MODULE_NOT_FOUND the next time it runs.');
|
|
552
|
-
console.log(
|
|
570
|
+
console.log(
|
|
571
|
+
` Fix: ${buildOverwriteCommand({ hasTemplates: installedTemplates.length > 0, hasSkill: skillInstalled })}`
|
|
572
|
+
);
|
|
553
573
|
console.log('');
|
|
554
574
|
}
|
|
555
575
|
|
|
@@ -558,7 +578,9 @@ async function runStatus(options) {
|
|
|
558
578
|
console.log(' If this repo\'s own package.json has "type": "module", every workflow that');
|
|
559
579
|
console.log(' require()s a script under .github/scripts will fail with "module is not');
|
|
560
580
|
console.log(' defined in ES module scope" the next time it runs.');
|
|
561
|
-
console.log(
|
|
581
|
+
console.log(
|
|
582
|
+
` Fix: ${buildOverwriteCommand({ hasTemplates: installedTemplates.length > 0, hasSkill: skillInstalled })}`
|
|
583
|
+
);
|
|
562
584
|
console.log('');
|
|
563
585
|
}
|
|
564
586
|
|
|
@@ -746,6 +768,7 @@ module.exports = {
|
|
|
746
768
|
readManifest,
|
|
747
769
|
writeManifest,
|
|
748
770
|
fetchLatestVersion,
|
|
771
|
+
buildOverwriteCommand,
|
|
749
772
|
skillPath,
|
|
750
773
|
SKILL_REL_PATH,
|
|
751
774
|
WORKFLOWS,
|