Skip to content

Latest commit

 

History

History
181 lines (136 loc) · 4.77 KB

PUBLISHING_READY.md

File metadata and controls

181 lines (136 loc) · 4.77 KB

🎉 All Packages Ready for npm Publishing!

All TortoiseOS packages have been updated with the @tortoise-os scope and are ready for publication.

✅ Completed Updates

Package Scope Changes

All packages migrated from @bun-move → @tortoise-os

Packages Updated (11 total)

  1. ✅ @tortoise-os/create-bun-move - CLI tool (READY TO PUBLISH NOW!)
  2. ✅ @tortoise-os/terrapin - Playwright testing utilities
  3. ✅ @tortoise-os/core - Core utilities and types
  4. ✅ @tortoise-os/sdk - TypeScript SDK for smart contracts
  5. ✅ @tortoise-os/hooks - React hooks for Sui
  6. ✅ @tortoise-os/components - Reusable UI components
  7. ✅ @tortoise-os/ui - Magic UI components
  8. ✅ @tortoise-os/burner-wallet - Burner wallet connector
  9. ✅ @tortoise-os/ai-integration - AI integration utilities
  10. ✅ @tortoise-os/move - Sui Move smart contracts
  11. ✅ @tortoise-os/move-deployer - Move deployer CLI

What Was Updated

For each package:

  • ✅ Scope: Changed to @tortoise-os
  • ✅ Repository metadata: Added repository, homepage, bugs URLs
  • ✅ publishConfig: Added access: "public"
  • ✅ Author: Added "TortoiseOS Team"
  • ✅ Keywords: Enhanced with relevant tags
  • ✅ Files: Added files array for npm publishing
  • ✅ READMEs: Created/updated awesome documentation

New READMEs Created

  • ✅ packages/core/README.md - Comprehensive core utilities docs
  • ✅ packages/sdk/README.md - Full SDK documentation with examples
  • ✅ packages/ui/README.md - Magic UI components showcase

Workspace Dependencies

  • ✅ All workspace references updated
  • ✅ Apps (web & api) updated to use new scopes
  • ✅ bun install successful - lockfile regenerated
  • ✅ No broken dependencies

📦 Publishing Order

Tier 1: Foundation (Publish First)

cd packages/create-bun-move
npm publish --access public

cd ../core
npm publish --access public

cd ../move
npm publish --access public

Tier 2: Infrastructure

cd packages/sdk
npm publish --access public

cd ../move-deployer
npm publish --access public

Tier 3: React Ecosystem

cd packages/hooks
npm publish --access public

cd ../components
npm publish --access public

cd ../ui
npm publish --access public

Tier 4: Specialized Tools

cd packages/terrapin
npm publish --access public

cd ../burner-wallet
npm publish --access public

cd ../ai-integration
npm publish --access public

🚀 Quick Publish All

# From monorepo root
for pkg in create-bun-move core move sdk move-deployer hooks components ui terrapin burner-wallet ai-integration; do
  echo "Publishing @tortoise-os/$pkg..."
  cd packages/$pkg
  npm publish --access public
  cd ../..
done

🧪 Pre-Publish Checklist

Before publishing, verify each package:

# Test package integrity
cd packages/PACKAGE_NAME
npm publish --dry-run

# Verify package.json
cat package.json | grep -A 5 "repository"

# Check what files will be published
npm pack --dry-run

📊 Package Status

Package Scope Metadata README Status
create-bun-move ✅ ✅ ✅ READY
terrapin ✅ ✅ ✅ READY
core ✅ ✅ ✅ READY
sdk ✅ ✅ ✅ READY
hooks ✅ ✅ ✅ READY
components ✅ ✅ ✅ READY
ui ✅ ✅ ✅ READY
burner-wallet ✅ ✅ ✅ READY
ai-integration ✅ ✅ ✅ READY
move ✅ ✅ ⚠️ READY
move-deployer ✅ ✅ ⚠️ READY

⚠️ = No README yet (not critical for these packages)

🎯 Next Steps

  1. Publish create-bun-move first - It's the entry point for new users
  2. Publish core & move - Foundation packages
  3. Publish remaining packages - In dependency order
  4. Update monorepo root README - Add npm installation instructions
  5. Create GitHub release - Tag v0.1.0 with changelog
  6. Announce on socials - Twitter, Discord, etc.

📝 Post-Publishing

After publishing, test installation:

# Create test directory
mkdir /tmp/test-tortoise
cd /tmp/test-tortoise

# Test create-bun-move
bunx @tortoise-os/create-bun-move my-test-app

# Test individual packages
bun add @tortoise-os/core
bun add @tortoise-os/sdk
bun add @tortoise-os/terrapin

🔗 NPM Links

After publishing, packages will be available at:

Everything is ready! 🐢🚀

All packages have been professionally configured with awesome READMEs, proper metadata, and are ready for the npm ecosystem.