Skip to content

Commit 12de5a6

Browse files
committed
docs: add package release guidance
1 parent ff036f1 commit 12de5a6

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

.github/pull_request_template.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Release checklist
2+
3+
- [ ] Bumped every affected public package with `npm version ... --no-git-tag-version`.
4+
- [ ] No published package files changed; version bump is not needed.
5+
6+
List affected packages and release level, or explain why no package releases.

AGENTS.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Agent instructions
2+
3+
## Package release policy
4+
5+
This repository is npm workspace monorepo. Each public package under `packages/*` releases independently.
6+
7+
- Bump package version when change affects published files, runtime behavior, public API, package metadata, or runtime dependencies.
8+
- Bump every affected package when one change touches multiple packages.
9+
- Do not bump version for root-only CI, Dependabot, development dependency, test-only, or repository documentation changes.
10+
- Use patch for fixes, minor for backward-compatible features, and major for breaking changes.
11+
- Bump with npm; do not edit versions by hand:
12+
13+
```bash
14+
npm version patch --workspace packages/<package> --no-git-tag-version
15+
```
16+
17+
- Commit version and `package-lock.json` changes with feature or fix. Do not create release tags.
18+
- Push `main`; `.github/workflows/publish.yml` publishes each public workspace whose version is newer than npm.
19+
- Root package `@henryqw/pi-packages` is private and never releases.
20+
- PR CI enforces version bumps for published package changes; test-only package changes are excluded.
21+
- Before finishing, state which packages release and why. If no package version changed, state that CI will not publish.

0 commit comments

Comments
 (0)