Skip to content

Commit b3c34f9

Browse files
Copilotchrisribe
andcommitted
Document automated version bumping in CHANGELOG and README
Co-authored-by: chrisribe <1999791+chrisribe@users.noreply.github.com>
1 parent 8c65353 commit b3c34f9

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
## [Unreleased]
99

1010
### Added
11+
- **Automated Version Bumping**: GitHub Actions workflow automatically bumps patch version on every commit/merge to main branch
12+
- Uses existing `npm run build:release` command
13+
- Commits changes back to repository with `[skip-version]` tag
14+
- Skips markdown and documentation-only changes
15+
- Prevents infinite loops with bot detection
16+
1117
- **Export/Import System**: Backup and restore memories across machines
1218
- `export-memory` command - Export memories to JSON with optional filtering
1319
- `import-memory` command - Import memories with duplicate detection

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,9 @@ npm run dev
435435
# Build TypeScript
436436
npm run build
437437

438+
# Build with version bump (for releases)
439+
npm run build:release
440+
438441
# Run all tests (28 tests)
439442
npm run test:all
440443

@@ -456,6 +459,20 @@ npm unlink -g # Unlink from global
456459
simple-memory memory-stats # Test the global command
457460
```
458461

462+
### Versioning
463+
464+
The project uses automated version bumping:
465+
466+
- **Development builds**: Use `npm run build` (no version change)
467+
- **Release builds**: Use `npm run build:release` (bumps patch version)
468+
- **Manual version bumps**: Use `npm run version:patch|minor|major`
469+
- **Automatic**: All commits/merges to `main` automatically bump the patch version via GitHub Actions
470+
471+
The workflow skips version bumps for:
472+
- Documentation-only changes (`.md` files)
473+
- Changes to `.github/` directory
474+
- Commits containing `[skip-version]` in the message
475+
459476
### Testing
460477

461478
The project has comprehensive test coverage:

0 commit comments

Comments
 (0)