@agwab/pi-workflow 0.1.0 → 0.1.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/docs/usage.md +0 -27
- package/package.json +2 -3
- package/docs/release.md +0 -89
- package/node_modules/@pondwader/socks5-server/.DS_Store +0 -0
- package/node_modules/commander/.DS_Store +0 -0
- package/node_modules/jiti/.DS_Store +0 -0
- package/node_modules/node-forge/.DS_Store +0 -0
- package/node_modules/shell-quote/.DS_Store +0 -0
- package/node_modules/zod/.DS_Store +0 -0
package/docs/usage.md
CHANGED
|
@@ -576,30 +576,3 @@ for those tools. Object-form custom tool `extensions` are merged with this
|
|
|
576
576
|
built-in mapping and deduplicated for the subagent launch. Web calls can still
|
|
577
577
|
fail when network access, provider credentials, browser state, or quota are
|
|
578
578
|
unavailable; research workflows should report those limits instead of guessing.
|
|
579
|
-
|
|
580
|
-
## Release checks
|
|
581
|
-
|
|
582
|
-
This repository releases through GitHub Actions, following the same release shape as `@agwab/pi-subagent`:
|
|
583
|
-
|
|
584
|
-
- scoped npm package name: `@agwab/pi-workflow`
|
|
585
|
-
- `private: false`
|
|
586
|
-
- `publishConfig.access: public`
|
|
587
|
-
- Pi package manifest in `package.json`
|
|
588
|
-
- README + `docs/usage.md`
|
|
589
|
-
- manual `.github/workflows/publish.yml` dispatch with npm provenance
|
|
590
|
-
|
|
591
|
-
Before publishing, maintainers should run the public checks and inspect the package surface:
|
|
592
|
-
|
|
593
|
-
```bash
|
|
594
|
-
npm run release:check
|
|
595
|
-
```
|
|
596
|
-
|
|
597
|
-
`npm run release:check` verifies package metadata, npm login, unpublished version, script syntax, typecheck, unit tests, e2e smoke, build, package contents, local-path/secret-like text, and `npm publish --dry-run`.
|
|
598
|
-
|
|
599
|
-
After an approved release plan, dispatch the release automation instead of publishing locally:
|
|
600
|
-
|
|
601
|
-
```bash
|
|
602
|
-
npm run release:dispatch -- <version> --watch
|
|
603
|
-
```
|
|
604
|
-
|
|
605
|
-
See [`docs/release.md`](./release.md) for the maintainer release checklist, CI workflow, publish workflow, and post-release verification steps.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agwab/pi-workflow",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Workflow orchestration for Pi subagents.",
|
|
5
5
|
"private": false,
|
|
6
6
|
"type": "module",
|
|
@@ -12,7 +12,6 @@
|
|
|
12
12
|
"workflows",
|
|
13
13
|
"skills",
|
|
14
14
|
"docs/usage.md",
|
|
15
|
-
"docs/release.md",
|
|
16
15
|
"docs/assets/readme/logo.svg",
|
|
17
16
|
"docs/assets/readme/stage-types.png",
|
|
18
17
|
"docs/assets/readme/deep-research-flow.png",
|
|
@@ -48,7 +47,7 @@
|
|
|
48
47
|
"validate": "npm run check:scripts && npm run typecheck && npm run test:unit",
|
|
49
48
|
"test": "npm run test:unit",
|
|
50
49
|
"test:build": "rm -rf .tmp/unit && tsc -p tsconfig.json --outDir .tmp/unit --noEmit false",
|
|
51
|
-
"test:unit": "npm run test:build && node --test test/unit/*.test.mjs",
|
|
50
|
+
"test:unit": "npm run build && npm run test:build && node --test test/unit/*.test.mjs",
|
|
52
51
|
"e2e": "node test/e2e/run.mjs",
|
|
53
52
|
"pack:dry": "npm pack --dry-run --json",
|
|
54
53
|
"prepack": "npm run build",
|
package/docs/release.md
DELETED
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
# pi-workflow release process
|
|
2
|
-
|
|
3
|
-
This repository releases `@agwab/pi-workflow` through the GitHub Actions **Publish** workflow. Local commands validate and dispatch the approved workflow; they should not replace the CI publish path.
|
|
4
|
-
|
|
5
|
-
## Rules
|
|
6
|
-
|
|
7
|
-
Do not publish, tag, push a release commit, or dispatch release automation until the exact release plan is approved. The plan must include:
|
|
8
|
-
|
|
9
|
-
- target version
|
|
10
|
-
- semver rationale
|
|
11
|
-
- changelog/release notes
|
|
12
|
-
- validation to run
|
|
13
|
-
- publish target (`@agwab/pi-workflow` on npm)
|
|
14
|
-
- downstream dependency/lockfile impact, especially bundled `@agwab/pi-subagent` and `pi-web-access`
|
|
15
|
-
|
|
16
|
-
Version bumps are release-task-only. The Publish workflow runs `npm version <target>` and pushes the release commit/tag after validation.
|
|
17
|
-
|
|
18
|
-
## Local validation
|
|
19
|
-
|
|
20
|
-
Run the full release gate before asking for final approval:
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
npm run release:check
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
`release:check` verifies package metadata, npm login, unpublished version, script syntax, typecheck, unit tests, e2e smoke, build, package contents, local-path/secret-like text, and `npm publish --dry-run`.
|
|
27
|
-
|
|
28
|
-
For normal CI-style validation without npm login or unpublished-version checks, run:
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
npm run validate
|
|
32
|
-
npm run e2e
|
|
33
|
-
npm run pack:dry
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
## Dispatching a release
|
|
37
|
-
|
|
38
|
-
After approval and after `main` is clean and pushed:
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
npm run release:dispatch -- <version> --watch
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
The dispatch script checks that:
|
|
45
|
-
|
|
46
|
-
- the current branch is `main`
|
|
47
|
-
- the working tree is clean
|
|
48
|
-
- `HEAD` matches `origin/main`
|
|
49
|
-
- the target version is semver-like
|
|
50
|
-
|
|
51
|
-
Then it dispatches `.github/workflows/publish.yml` with `version=<version>`.
|
|
52
|
-
|
|
53
|
-
## GitHub Actions
|
|
54
|
-
|
|
55
|
-
### CI
|
|
56
|
-
|
|
57
|
-
`.github/workflows/ci.yml` runs on pull requests and pushes to `main`:
|
|
58
|
-
|
|
59
|
-
1. `npm ci --legacy-peer-deps`
|
|
60
|
-
2. `npm run validate`
|
|
61
|
-
3. `npm run e2e`
|
|
62
|
-
4. `npm run pack:dry`
|
|
63
|
-
|
|
64
|
-
### Publish
|
|
65
|
-
|
|
66
|
-
`.github/workflows/publish.yml` is manual-only (`workflow_dispatch`) and only runs on `main`. It:
|
|
67
|
-
|
|
68
|
-
1. installs dependencies with npm
|
|
69
|
-
2. configures the GitHub Actions bot git author
|
|
70
|
-
3. runs `npm version <target>` if needed and creates `v<target>`
|
|
71
|
-
4. checks whether `@agwab/pi-workflow@<target>` already exists on npm
|
|
72
|
-
5. runs `npm run release:check` for unpublished versions
|
|
73
|
-
6. runs validation-only checks for already-published versions
|
|
74
|
-
7. publishes to npm with provenance when needed
|
|
75
|
-
8. pushes the release commit and tag when needed
|
|
76
|
-
9. creates a GitHub release when missing
|
|
77
|
-
|
|
78
|
-
## Post-release verification
|
|
79
|
-
|
|
80
|
-
After the workflow completes, verify and report:
|
|
81
|
-
|
|
82
|
-
```bash
|
|
83
|
-
npm view @agwab/pi-workflow@<version> version
|
|
84
|
-
gh release view v<version>
|
|
85
|
-
git fetch origin --tags
|
|
86
|
-
git rev-parse v<version>
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
Also report the GitHub Actions run URL and any skipped steps, such as publish skipped because the npm version already existed.
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|