@williambeto/ai-workflow 1.18.10 → 1.18.13
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/CHANGELOG.md +24 -0
- package/docs/full-documentation.md +2 -2
- package/package.json +1 -1
- package/runbooks/apply-starter-to-real-project.md +4 -4
- package/runbooks/publish-package-checklist.md +9 -0
- package/schemas/functional-spec.schema.json +1 -1
- package/schemas/handoff.schema.json +1 -1
- package/schemas/pr-breakdown.schema.json +1 -1
- package/schemas/requirement.schema.json +1 -1
- package/schemas/technical-plan.schema.json +1 -1
- package/schemas/validation-report.schema.json +1 -1
- package/runbooks/from-zero-to-first-pr.md +0 -18
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,27 @@
|
|
|
1
|
+
## [1.18.13](https://github.com/williambeto/ai-workflow/compare/v1.18.12...v1.18.13) (2026-05-22)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* remove --provenance flag for private repo publish ([#57](https://github.com/williambeto/ai-workflow/issues/57)) ([557a41e](https://github.com/williambeto/ai-workflow/commit/557a41ed5f56071d932f494ebac0ebd1740d98ec))
|
|
7
|
+
|
|
8
|
+
## [1.18.12](https://github.com/williambeto/ai-workflow/compare/v1.18.11...v1.18.12) (2026-05-22)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* skip auto-generated CHANGELOG.md from markdownlint and link validation ([#56](https://github.com/williambeto/ai-workflow/issues/56)) ([aefc44d](https://github.com/williambeto/ai-workflow/commit/aefc44d3b137b99e6089763952a8973de74f2ce6))
|
|
14
|
+
|
|
15
|
+
## [1.18.11](https://github.com/williambeto/ai-workflow/compare/v1.18.10...v1.18.11) (2026-05-22)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Bug Fixes
|
|
19
|
+
|
|
20
|
+
* apply readiness audit fixes (security, package, branding, docs) ([9721661](https://github.com/williambeto/ai-workflow/commit/972166100908681f27889e9ddd10de71f20a9627))
|
|
21
|
+
* apply readiness audit fixes (security, package, branding, docs) ([ee60c7c](https://github.com/williambeto/ai-workflow/commit/ee60c7cabab77dc45684d8e1b91533566660e794))
|
|
22
|
+
* update semantic-release CI to Node.js 22 ([8bbaabb](https://github.com/williambeto/ai-workflow/commit/8bbaabbefa3ffe1a27b19264bc8c98779ba4bddd))
|
|
23
|
+
* update semantic-release CI to Node.js 22 ([89a198a](https://github.com/williambeto/ai-workflow/commit/89a198aadd21f10c8b3d65e21a58747e50c23703))
|
|
24
|
+
|
|
1
25
|
# Changelog
|
|
2
26
|
|
|
3
27
|
All notable changes to AI Workflow Kit (`ai-workflow`) are documented in this file.
|
|
@@ -99,7 +99,7 @@ ai-workflow/
|
|
|
99
99
|
|
|
100
100
|
| Path | Purpose |
|
|
101
101
|
| --- | --- |
|
|
102
|
-
|
|
|
102
|
+
| `AGENTS.md` | Main operational contract for AI agents in this repository. |
|
|
103
103
|
| [`.agents/skills/`](.agents/skills/) | Reusable specialist skill definitions. |
|
|
104
104
|
| [`.agents/napkin.md`](.agents/napkin.md) | Durable project memory index. |
|
|
105
105
|
| [`.codex/prompts/`](.codex/prompts/) | Compact Codex prompt entrypoints. |
|
|
@@ -334,7 +334,7 @@ Runbooks are operational guides for applying the workflow.
|
|
|
334
334
|
| Runbook | Purpose |
|
|
335
335
|
| --- | --- |
|
|
336
336
|
| [`runbooks/quick-start-guide.md`](runbooks/quick-start-guide.md) | Fastest path to first value. |
|
|
337
|
-
|
|
|
337
|
+
| <!-- consolidated into quick-start-guide.md --> | |
|
|
338
338
|
| [`runbooks/apply-starter-to-real-project.md`](runbooks/apply-starter-to-real-project.md) | Apply this workflow to a target project. |
|
|
339
339
|
| [`runbooks/validate-starter-in-real-project.md`](runbooks/validate-starter-in-real-project.md) | Prove adoption in a real project. |
|
|
340
340
|
| [`runbooks/how-to-use-skills.md`](runbooks/how-to-use-skills.md) | Choose specialist skills. |
|
package/package.json
CHANGED
|
@@ -25,7 +25,7 @@ Use this runbook when:
|
|
|
25
25
|
- starting a new project;
|
|
26
26
|
- auditing an existing project;
|
|
27
27
|
- setting up Codex/OpenCode workflows;
|
|
28
|
-
- preparing a
|
|
28
|
+
- preparing a target project;
|
|
29
29
|
- creating a PR-driven implementation plan;
|
|
30
30
|
- reducing repeated prompt/context setup.
|
|
31
31
|
|
|
@@ -100,8 +100,8 @@ Choose one adoption level for the project. Start lower, then expand only when th
|
|
|
100
100
|
|
|
101
101
|
| Level | When to use | What to copy/adapt | Risk |
|
|
102
102
|
| ----- | ----------- | ------------------ | ---- |
|
|
103
|
-
| Level 1 — Minimal | Small bug fixes, short documentation updates, or early trials in an existing project. | `AGENTS.md`, `README.md`, `.codex/prompts/`, and `npm run validate` only if the validation scripts are copied. | May not provide enough structure for multi-PR work,
|
|
104
|
-
| Level 2 — Operational | Serious feature work,
|
|
103
|
+
| Level 1 — Minimal | Small bug fixes, short documentation updates, or early trials in an existing project. | `AGENTS.md`, `README.md`, `.codex/prompts/`, and `npm run validate` only if the validation scripts are copied. | May not provide enough structure for multi-PR work, team handoff, or repeatable review. |
|
|
104
|
+
| Level 2 — Operational | Serious feature work, production projects, repo audits, or teams that need recurring Codex/OpenCode workflows. | `AGENTS.md`, `harness/`, `opencode/commands/`, `opencode/agents/`, selected skills, and validation scripts. | Requires project-specific adaptation; copied rules can drift if nobody owns them. |
|
|
105
105
|
| Level 3 — Full workflow | Long-lived products, team workflow design, training repositories, or projects that need examples and structured contracts. | `prompts/`, `templates/`, `harness/`, `schemas/`, `examples/`, agents, skills, runbooks, and validation scripts. | Highest setup cost; can become process-heavy if copied without pruning. |
|
|
106
106
|
|
|
107
107
|
Do not use Level 3 just because the starter contains more files. Use it when the target project needs a durable workflow system.
|
|
@@ -372,7 +372,7 @@ Skills:
|
|
|
372
372
|
|
|
373
373
|
Use Level 2 when the project already has its own examples, conventions, and validation commands. Use Level 3 when the team needs repeatable planning documents, schemas, and long-lived workflow examples.
|
|
374
374
|
|
|
375
|
-
### B. WordPress
|
|
375
|
+
### B. WordPress project
|
|
376
376
|
|
|
377
377
|
Recommended adoption:
|
|
378
378
|
|
|
@@ -10,6 +10,15 @@ Use this runbook to publish `@williambeto/ai-workflow` to npm with explicit safe
|
|
|
10
10
|
- Registry: npm
|
|
11
11
|
- Workflow: `.github/workflows/publish-npm.yml`
|
|
12
12
|
|
|
13
|
+
## Publish path architecture
|
|
14
|
+
|
|
15
|
+
This project uses a dual-path publish architecture:
|
|
16
|
+
|
|
17
|
+
- **Semantic release** (`.releaserc.json`): handles version bumps, changelog generation, and GitHub release creation. npm publish is explicitly disabled (`"npmPublish": false`) because actual publishing is handled by the manual CI workflow.
|
|
18
|
+
- **Manual CI workflow** (`.github/workflows/publish-npm.yml`): the only path that actually publishes to npm. Requires explicit `workflow_dispatch` with dry-run gate.
|
|
19
|
+
|
|
20
|
+
This split prevents accidental automated npm publishes while keeping semantic-release benefits for changelog and versioning.
|
|
21
|
+
|
|
13
22
|
## Safety gates
|
|
14
23
|
|
|
15
24
|
1. Run only from `main`.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"$id": "https://
|
|
2
|
+
"$id": "https://github.com/williambeto/ai-workflow/schemas/functional-spec.schema.json",
|
|
3
3
|
"title": "Functional Specification",
|
|
4
4
|
"type": "object",
|
|
5
5
|
"additionalProperties": false,
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
# From Zero to First PR
|
|
2
|
-
|
|
3
|
-
> **This guide has been consolidated into [`runbooks/quick-start-guide.md`](runbooks/quick-start-guide.md).**
|
|
4
|
-
>
|
|
5
|
-
> All content is now available there: install instructions, profile selection, step-by-step workflow with prompts and skills per step, validation checklists, common mistakes, recommended PR types, and first PR quality gate.
|
|
6
|
-
>
|
|
7
|
-
> Redirect to [`runbooks/quick-start-guide.md`](runbooks/quick-start-guide.md).
|
|
8
|
-
|
|
9
|
-
## Quick reference
|
|
10
|
-
|
|
11
|
-
| Topic | Link |
|
|
12
|
-
| --- | --- |
|
|
13
|
-
| Full walkthrough | [`runbooks/quick-start-guide.md`](runbooks/quick-start-guide.md) |
|
|
14
|
-
| Workflow steps with prompts and skills | Quick-Start Guide → Workflow steps reference |
|
|
15
|
-
| Validation checklists per step | Quick-Start Guide → Validation checklist per step |
|
|
16
|
-
| Common mistakes to avoid | Quick-Start Guide → Common mistakes |
|
|
17
|
-
| First PR quality gate | Quick-Start Guide → First PR quality gate |
|
|
18
|
-
| Complete reference documentation | [`docs/full-documentation.md`](docs/full-documentation.md) |
|