getcompanion-ai/co-mono
1
0
Fork 0
mirror of https://github.com/getcompanion-ai/co-mono.git synced 2026-04-15 06:04:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
co-mono/PUBLISHING.md
Mario Zechner a74c5da112 Initial monorepo setup with npm workspaces and dual TypeScript configuration 
- Set up npm workspaces for three packages: pi-tui, pi-agent, and pi (pods)
- Implemented dual TypeScript configuration:
  - Root tsconfig.json with path mappings for development and type checking
  - Package-specific tsconfig.build.json for clean production builds
- Configured lockstep versioning with sync script for inter-package dependencies
- Added comprehensive documentation for development and publishing workflows
- All packages at version 0.5.0 ready for npm publishing
2025-08-09 17:18:38 +02:00

1.7 KiB
Raw Blame History

Publishing Guide

Publishing Workflow

1. Pre-publish Checks

# Clean everything and rebuild from scratch
npm run clean
npm run build

# Run all checks
npm run check

# Test packages work correctly
cd packages/agent && npx tsx src/cli.ts --help
cd packages/pods && npx tsx src/cli.ts --help

2. Version Bump

All packages use lockstep versioning (same version number):

# Patch version bump (0.5.0 -> 0.5.1)
npm run version:patch

# Minor version bump (0.5.0 -> 0.6.0)
npm run version:minor  

# Major version bump (0.5.0 -> 1.0.0)
npm run version:major

This automatically:

  • Updates all package versions
  • Syncs inter-package dependencies

3. Commit & Tag

# Commit the version bump
git add -A
git commit -m "Release v0.5.1"

# Tag the release
git tag -a v0.5.1 -m "Release v0.5.1"

# Push to GitHub
git push origin main --tags

4. Publish to npm

# Dry run first (see what would be published)
npm run publish:dry

# If everything looks good, publish for real
npm run publish:all

This will:

  1. Clean all dist folders
  2. Build all packages in dependency order
  3. Run all checks
  4. Publish all packages to npm with public access

5. Verify Publication

# Check npm registry
npm view @mariozechner/pi-tui
npm view @mariozechner/pi-agent  
npm view @mariozechner/pi

# Test installation
npx @mariozechner/pi --help
npx @mariozechner/pi-agent --help

Notes

  • All packages are published with --access public flag
  • The prepublishOnly script in each package ensures clean builds
  • Dependencies between packages use ^ version ranges for flexibility
  • The monorepo itself (pi-monorepo) is private and not published