mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-17 05:00:16 +00:00
docs: update changelogs and clarify lockstep versioning in AGENTS.md
This commit is contained in:
parent
d82df76222
commit
cf922b01b4
3 changed files with 12 additions and 3 deletions
13
AGENTS.md
13
AGENTS.md
|
|
@ -77,13 +77,20 @@ Use these sections under `## [Unreleased]`:
|
|||
|
||||
## Releasing
|
||||
|
||||
**Lockstep versioning**: All packages always share the same version number. Every release updates all packages together.
|
||||
|
||||
**Version semantics** (no major releases):
|
||||
- `patch`: Bug fixes and new features
|
||||
- `minor`: API breaking changes
|
||||
|
||||
### Steps
|
||||
|
||||
1. **Update CHANGELOGs**: Ensure all changes since last release are documented in the `[Unreleased]` section of each affected package's CHANGELOG.md
|
||||
|
||||
2. **Run release script**:
|
||||
```bash
|
||||
npm run release:patch # Bug fixes
|
||||
npm run release:minor # New features
|
||||
npm run release:major # Breaking changes
|
||||
npm run release:patch # Fixes and additions
|
||||
npm run release:minor # API breaking changes
|
||||
```
|
||||
|
||||
The script handles: version bump, CHANGELOG finalization, commit, tag, publish, and adding new `[Unreleased]` sections.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue