@pieai/pro-gov 0.3.7 → 0.3.8
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 +23 -9
- package/assets/docs/reference/adoption/adoption-playbook.md +29 -9
- package/assets/docs/reference/adoption/project-relationship.md +14 -15
- package/assets/docs/reference/adoption/recommended-agent-tooling.md +23 -1
- package/assets/integrations/compound-engineering.md +124 -0
- package/assets/integrations/ponytail.md +52 -0
- package/assets/integrations/superpowers.md +21 -8
- package/assets/profiles/doc-only/manifest.yml +2 -0
- package/assets/profiles/doc-only/profile.md +4 -4
- package/assets/profiles/engineering-runtime/manifest.yml +2 -0
- package/assets/profiles/engineering-runtime/profile.md +6 -4
- package/assets/starter/AGENTS.template.md +2 -1
- package/assets/starter/docs/governance/boundary.md +7 -0
- package/assets/starter/docs/governance/ssot-v0.9.md +12 -0
- package/assets/starter/docs/reference/documentation-map.md +5 -0
- package/cli-guide.md +34 -6
- package/dist/cli.js +473 -38
- package/package.json +2 -2
- package/assets/docs/reference/adoption/public-release-checklist.md +0 -153
- package/assets/docs/reference/adoption/site-publication-brief.md +0 -94
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pieai/pro-gov",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.8",
|
|
4
4
|
"description": "Project-level distribution kit for Project Governance System.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ai-agents",
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"access": "public"
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@pieai/doc-gov": "^0.3.
|
|
38
|
+
"@pieai/doc-gov": "^0.3.8"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@types/node": "24.13.2",
|
|
@@ -1,153 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
id: REF-PUBLIC-RELEASE-CHECKLIST
|
|
3
|
-
title: Public Release Checklist
|
|
4
|
-
type: reference
|
|
5
|
-
status: stable
|
|
6
|
-
canonical: true
|
|
7
|
-
owner: human
|
|
8
|
-
created: 2026-06-04
|
|
9
|
-
last_reviewed: 2026-06-30
|
|
10
|
-
domain: adoption
|
|
11
|
-
tags:
|
|
12
|
-
- release
|
|
13
|
-
- npm
|
|
14
|
-
- github
|
|
15
|
-
pinned: false
|
|
16
|
-
related:
|
|
17
|
-
- POLICY-SYNC-STRATEGY
|
|
18
|
-
- POLICY-VERSIONING
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
# Public Release Checklist
|
|
22
|
-
|
|
23
|
-
Use this before making the repository public or publishing `@pieai/doc-gov` or
|
|
24
|
-
`@pieai/pro-gov`.
|
|
25
|
-
|
|
26
|
-
## Mental Model
|
|
27
|
-
|
|
28
|
-
Making the GitHub repository public is like opening the workshop doors. People
|
|
29
|
-
can inspect the benches, the notes, and the commit history.
|
|
30
|
-
|
|
31
|
-
Publishing to npm is like putting a tool on a public shelf. People can install
|
|
32
|
-
it without cloning the workshop.
|
|
33
|
-
|
|
34
|
-
Both need checks, but they are not the same release.
|
|
35
|
-
|
|
36
|
-
## Repository Public Checklist
|
|
37
|
-
|
|
38
|
-
Before changing GitHub visibility:
|
|
39
|
-
|
|
40
|
-
- current working tree is clean
|
|
41
|
-
- current branch is pushed
|
|
42
|
-
- current files have no secrets
|
|
43
|
-
- Git history has no real secrets
|
|
44
|
-
- current files have no machine-local startup paths
|
|
45
|
-
- root README explains the project to outsiders
|
|
46
|
-
- license and security contact exist
|
|
47
|
-
- CI is present and runs the standard doc-gov gate
|
|
48
|
-
|
|
49
|
-
Recommended commands:
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
git status --short --branch
|
|
53
|
-
pnpm typecheck
|
|
54
|
-
pnpm test
|
|
55
|
-
pnpm build
|
|
56
|
-
pnpm doc-gov doctor
|
|
57
|
-
git diff --check
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
## npm Publish Checklist
|
|
61
|
-
|
|
62
|
-
### AI Release Rule
|
|
63
|
-
|
|
64
|
-
The only supported release path for this repository is GitHub Actions Trusted
|
|
65
|
-
Publishing:
|
|
66
|
-
|
|
67
|
-
1. Verify both package versions are aligned and all local checks pass.
|
|
68
|
-
2. Commit and push the release-ready state to `main`.
|
|
69
|
-
3. Run `gh workflow run npm-publish.yml --ref main`.
|
|
70
|
-
4. Monitor the workflow to completion.
|
|
71
|
-
5. Confirm both versions from the official registry with `npm view`.
|
|
72
|
-
|
|
73
|
-
Do not run `npm publish` locally and do not create or reuse a long-lived npm
|
|
74
|
-
write token for this repository. Since December 2025, `npm login` creates a
|
|
75
|
-
short-lived session (currently two hours), not a durable release credential.
|
|
76
|
-
Local `npm whoami` therefore tests only local token authentication; it does not
|
|
77
|
-
report whether GitHub OIDC Trusted Publishing is configured or healthy.
|
|
78
|
-
|
|
79
|
-
Beginner version: pushing `main` makes the approved code available to the
|
|
80
|
-
release workflow, but it does not publish automatically. The explicit
|
|
81
|
-
`gh workflow run` command is the final safety switch. GitHub then proves the
|
|
82
|
-
workflow identity to npm and obtains a short-lived credential for that one
|
|
83
|
-
release.
|
|
84
|
-
|
|
85
|
-
Before publishing:
|
|
86
|
-
|
|
87
|
-
- `packages/doc-gov/package.json` has public package metadata
|
|
88
|
-
- `packages/pro-gov/package.json` has public package metadata
|
|
89
|
-
- each package has a README
|
|
90
|
-
- each package has a license
|
|
91
|
-
- each package has a built executable under `dist/cli.js`
|
|
92
|
-
- package dry-runs show only intended files
|
|
93
|
-
- publish `@pieai/doc-gov` before `@pieai/pro-gov` when both package versions
|
|
94
|
-
are new, because `pro-gov` depends on the matching validator release
|
|
95
|
-
- npm Trusted Publisher is configured for both packages
|
|
96
|
-
- registry is the official npm registry, not a mirror
|
|
97
|
-
- scoped publish uses public access
|
|
98
|
-
|
|
99
|
-
Recommended local verification:
|
|
100
|
-
|
|
101
|
-
```bash
|
|
102
|
-
pnpm --filter @pieai/doc-gov pack --dry-run
|
|
103
|
-
pnpm --filter @pieai/pro-gov pack --dry-run
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
Recommended publish command:
|
|
107
|
-
|
|
108
|
-
```bash
|
|
109
|
-
gh workflow run npm-publish.yml --ref main
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
Important: do not claim an npm package is live until its `npm view <package>
|
|
113
|
-
version` command resolves from the public registry.
|
|
114
|
-
|
|
115
|
-
## Trusted Publishing Setup
|
|
116
|
-
|
|
117
|
-
npm publishing should use Trusted Publishing through GitHub Actions. This is the
|
|
118
|
-
smooth path: GitHub Actions proves to npm that a specific workflow in this
|
|
119
|
-
repository is publishing the package, so maintainers do not need to pass a
|
|
120
|
-
long-lived npm token around.
|
|
121
|
-
|
|
122
|
-
Set this once for each package on npmjs.com:
|
|
123
|
-
|
|
124
|
-
1. Open the package settings for `@pieai/doc-gov`.
|
|
125
|
-
2. Add a Trusted Publisher for GitHub Actions:
|
|
126
|
-
- owner: `PieAIStudio`
|
|
127
|
-
- repository: `ProjectGovernanceSystem`
|
|
128
|
-
- workflow file: `npm-publish.yml`
|
|
129
|
-
- allowed action: `npm publish`
|
|
130
|
-
3. Repeat the same setup for `@pieai/pro-gov`.
|
|
131
|
-
4. Keep the workflow as manual `workflow_dispatch` until several releases have
|
|
132
|
-
succeeded.
|
|
133
|
-
|
|
134
|
-
The workflow must keep:
|
|
135
|
-
|
|
136
|
-
- `permissions.id-token: write`
|
|
137
|
-
- a GitHub-hosted runner
|
|
138
|
-
- npm CLI `11.5.1` or newer
|
|
139
|
-
- package `repository` fields that match the public GitHub repository
|
|
140
|
-
- `pnpm pack` before publish, so workspace dependencies are converted in the
|
|
141
|
-
tarball
|
|
142
|
-
- `npm publish <tarball> --provenance --access public`
|
|
143
|
-
|
|
144
|
-
## After Release
|
|
145
|
-
|
|
146
|
-
After GitHub and npm are live:
|
|
147
|
-
|
|
148
|
-
- verify the GitHub URL in a browser or with `gh repo view`
|
|
149
|
-
- verify npm versions with `npm view @pieai/doc-gov version` and
|
|
150
|
-
`npm view @pieai/pro-gov version`
|
|
151
|
-
- update downstream projects only through an explicit sync task
|
|
152
|
-
- update public website copy from the current README and this checklist, not
|
|
153
|
-
from stale chat history
|
|
@@ -1,94 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
id: REF-SITE-PUBLICATION-BRIEF
|
|
3
|
-
title: Website Publication Brief
|
|
4
|
-
type: reference
|
|
5
|
-
status: stable
|
|
6
|
-
canonical: true
|
|
7
|
-
owner: human
|
|
8
|
-
created: 2026-06-04
|
|
9
|
-
last_reviewed: 2026-06-13
|
|
10
|
-
domain: adoption
|
|
11
|
-
tags:
|
|
12
|
-
- website
|
|
13
|
-
- public
|
|
14
|
-
- handoff
|
|
15
|
-
pinned: false
|
|
16
|
-
related:
|
|
17
|
-
- REF-PUBLIC-RELEASE-CHECKLIST
|
|
18
|
-
- REF-PROJECT-RELATIONSHIP
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
# Website Publication Brief
|
|
22
|
-
|
|
23
|
-
Use this when asking the PieAI Studio website project to add Project Governance
|
|
24
|
-
System as a public project page.
|
|
25
|
-
|
|
26
|
-
## Public Positioning
|
|
27
|
-
|
|
28
|
-
Project Governance System keeps long-running AI-assisted projects understandable
|
|
29
|
-
and governable.
|
|
30
|
-
|
|
31
|
-
Beginner-friendly description:
|
|
32
|
-
|
|
33
|
-
> AI can create plans, specifications, rules, and reports faster than people can
|
|
34
|
-
> organize them. Project Governance System is the librarian, traffic desk, and
|
|
35
|
-
> inspection machine: it keeps current truth easy to find, sends each task down
|
|
36
|
-
> the right route, and checks that important project evidence is still connected.
|
|
37
|
-
|
|
38
|
-
## What To Emphasize
|
|
39
|
-
|
|
40
|
-
- It reduces the cognitive load of returning to an AI-assisted project after
|
|
41
|
-
days, weeks, or many different AI sessions.
|
|
42
|
-
- It keeps AI-generated specs, plans, decisions, references, and routing rules
|
|
43
|
-
from becoming unmanaged clutter.
|
|
44
|
-
- It separates central governance rules from project-local truth.
|
|
45
|
-
- It has two practical profiles: engineering-runtime and doc-only.
|
|
46
|
-
- It provides `doc-gov` commands for schema checks, manifest freshness, link
|
|
47
|
-
checks, router integrity, health checks, and read-only migration checks.
|
|
48
|
-
- It provides `pro-gov` commands for packaged starter/profile assets,
|
|
49
|
-
read-only init planning, read-only sync checks, and package health checks.
|
|
50
|
-
- It includes ProjectLens-style read-only inspection and a governed local agent
|
|
51
|
-
asset registry without publishing private or third-party skill bodies.
|
|
52
|
-
- It works with external workflow systems instead of replacing them:
|
|
53
|
-
Superpowers owns engineering process, while Ponytail may act as an optional
|
|
54
|
-
complexity adviser with global mode `off`.
|
|
55
|
-
|
|
56
|
-
## Do Not Overclaim
|
|
57
|
-
|
|
58
|
-
- Do not say it replaces Git.
|
|
59
|
-
- Do not say it replaces Superpowers.
|
|
60
|
-
- Do not say it requires or automatically enables Ponytail.
|
|
61
|
-
- Do not promise a fixed percentage reduction in code, tokens, time, or cost.
|
|
62
|
-
- Do not say it automatically migrates every project.
|
|
63
|
-
- Do not imply product prompts, generated media, or runtime assets must move
|
|
64
|
-
under `docs/**`.
|
|
65
|
-
|
|
66
|
-
## Suggested Website Prompt
|
|
67
|
-
|
|
68
|
-
```text
|
|
69
|
-
Read <local ProjectGovernanceSystem checkout path> as the source project.
|
|
70
|
-
|
|
71
|
-
Add Project Governance System to <local PieAIStudio-Site path> as a
|
|
72
|
-
public project surface. Follow the existing project-page pattern, homepage card
|
|
73
|
-
pattern, translations, and sitemap conventions in that website repository.
|
|
74
|
-
|
|
75
|
-
Use the central repo's README.md, packages/doc-gov/README.md,
|
|
76
|
-
packages/pro-gov/README.md, docs/reference/adoption/public-release-checklist.md,
|
|
77
|
-
and docs/reference/adoption/site-publication-brief.md as source material.
|
|
78
|
-
|
|
79
|
-
Position it for normal readers as the system that keeps long-running AI-assisted
|
|
80
|
-
projects understandable and governable. Lead with the pain: AI creates useful
|
|
81
|
-
plans, specs, rules, and evidence faster than people can organize and retire
|
|
82
|
-
them. Use the librarian, traffic desk, and inspection-machine analogy before
|
|
83
|
-
technical package details. Explain how it fits next to Git, AGENTS.md,
|
|
84
|
-
Superpowers, optional Ponytail advice, pro-gov starter/profile distribution,
|
|
85
|
-
ProjectLens inspection, and project-local product truth.
|
|
86
|
-
|
|
87
|
-
Keep the copy confident but accurate. Do not claim automatic migration or
|
|
88
|
-
full replacement of existing workflow tools. npm publication is live, so include
|
|
89
|
-
the package install commands for @pieai/doc-gov and @pieai/pro-gov, and link the
|
|
90
|
-
npm packages plus the GitHub repository.
|
|
91
|
-
|
|
92
|
-
After implementation, run the site's normal quality/typecheck/build checks and
|
|
93
|
-
verify the new public route plus sitemap entry.
|
|
94
|
-
```
|