@go-corp/workflow

🚀 Enterprise-ready release automation and workflow orchestration

A powerful, type-safe CLI tool built for modern development teams that need consistent, reliable release processes across all their projects.

✨ Features

🎯 Complete Release Pipeline

• Quality Gates: Auto-fix linting, type checking, test execution
• Git Operations: Smart version bumping, changelog generation, tagging
• Multi-Platform Publishing: npm, Cloudflare, GitHub releases
• Interactive UI: Beautiful progress indicators with listr2

🏢 Enterprise-Ready

• Type-Safe: Full TypeScript with comprehensive error handling
• Extensible: Plugin system for custom workflows
• Configurable: Skip steps, customize behavior per project
• AI-Powered: Smart branch names, commit suggestions (coming soon)

🌟 Developer Experience

• Zero Config: Works out of the box with sensible defaults
• Interactive: Smart deployment configuration and uncommitted changes handling
• Crash-Proof: Robust error handling prevents workflow interruptions
• Fast: Optimized performance with concurrent operations

🚀 Quick Start

Installation

# Install globally (recommended)
bun install -g @go-corp/workflow

# Or use in project
bun add --dev @go-corp/workflow

# Also available via npm/yarn/pnpm
npm install -g @go-corp/workflow

Basic Usage

# Interactive release workflow (recommended)
go-workflow release
# → Prompts for deployment targets (npm, Cloudflare)
# → Handles uncommitted changes interactively
# → Executes complete release pipeline

# Release with specific version bump
go-workflow release --type minor

# Skip specific deployments via CLI flags
go-workflow release --skip-cloudflare --skip-npm

# Force release with uncommitted changes
go-workflow release --force

# Non-interactive mode (for CI/CD)
go-workflow release --non-interactive --skip-cloudflare --skip-npm

# Show workflow status
go-workflow status

📋 Commands

go-workflow release

Execute the complete release workflow with interactive configuration:

🔧 Deployment Configuration
----------------------------------------
✔ 📦 Publish to npm registry? (y/N) · true

⚠️  Uncommitted changes detected:
  - README.md

? How would you like to handle uncommitted changes? › 📝 Commit all changes now
✅ Changes committed

✔ Quality Gates
  ✔ Auto-fix linting issues - ✅ Fixed
  ✔ Type checking - ✅ Passed
  ✔ Running tests - ✅ No tests found (skipping)
✔ Git repository analysis - ✅ golive-dev/workflow on main
✔ Version calculation - ✅ 2.10.1 → 2.11.0 (minor)
✔ Deployment configuration - ✅ Will deploy to: npm
✔ Release execution
  ✔ Update package.json version - ✅ 2.11.0
  ✔ Generate changelog - ✅ CHANGELOG.md updated
  ✔ Commit release changes - ✅ chore: release v2.11.0
  ✔ Create git tag - ✅ v2.11.0
  ✔ Push to remote - ✅ Complete
✔ Build project - ✅ Build complete
↓ Deploy to Cloudflare [SKIPPED]
✔ Publish to npm - ✅ v2.11.0 published (you may need to interact with prompts)
✔ Create GitHub release - ✅ v2.11.0 released

🎉 Release completed successfully!
📦 Version: 2.10.1 → 2.11.0
📂 Repository: golive-dev/workflow

Options:

• --type <patch|minor|major> - Force specific version bump
• --skip-tests - Skip test execution
• --skip-lint - Skip linting step
• --skip-cloudflare - Skip Cloudflare deployment (or use interactive prompt)
• --skip-npm - Skip npm publishing (or use interactive prompt)
• --non-interactive - Run without prompts (for CI/CD environments)
• --force - Skip uncommitted changes check
• --dry-run - Show what would be done without executing (coming soon)
• --verbose - Show detailed output

go-workflow feature (Coming Soon)

Create and manage feature branches with AI-powered suggestions:

go-workflow feature                    # AI suggests branch name
go-workflow feature "add-user-auth"    # Create specific feature
go-workflow feature --auto-merge       # Enable auto-merge on PR

go-workflow status

Show project and workflow status.

🏗️ Programmatic Usage

Use as a library in your Node.js applications:

import { createReleaseWorkflow, createTaskEngine, createWorkflow, quickRelease } from '@go-corp/workflow'

// Quick release with interactive prompts
await quickRelease({ type: 'minor' })

// Custom workflow (note: createReleaseWorkflow is now async)
const steps = await createReleaseWorkflow({
  skipTests: true,
  nonInteractive: true, // Skip prompts for programmatic use
  skipCloudflare: true,
  skipNpm: true
})
const engine = createTaskEngine({ showTimer: true })
const result = await engine.execute(steps)

// Build custom workflows
const customWorkflow = createWorkflow('deploy')
  .step('Build', async (ctx, helpers) => {
    helpers.setOutput('Building application...')
    // Your build logic
  })
  .step('Deploy', async (ctx, helpers) => {
    helpers.setOutput('Deploying to production...')
    // Your deploy logic
  })
  .build()

⚙️ Configuration (Coming Soon)

Create .go-workflow.config.js in your project root:

export default {
  project: {
    type: 'library', // 'library' | 'cli' | 'web-app' | 'api'
    packageManager: 'bun' // 'bun' | 'npm' | 'yarn' | 'pnpm'
  },

  git: {
    defaultBranch: 'main',
    branchNaming: {
      feature: 'feature/{name}',
      bugfix: 'bugfix/{name}',
      hotfix: 'hotfix/{name}'
    }
  },

  deployments: {
    npm: {
      enabled: true,
      access: 'public'
    },
    cloudflare: {
      enabled: true,
      buildCommand: 'npm run build'
    }
  },

  github: {
    autoRelease: true,
    pullRequests: {
      autoMerge: true,
      deleteBranch: true
    }
  }
}

🔧 Requirements

• Node.js: >= 18.0.0
• Git: For version control operations
• GitHub CLI (optional): For GitHub integrations (gh command)
• Wrangler (optional): For Cloudflare deployments

🏢 Enterprise Features

Multi-Project Consistency

Install once, use everywhere. Same commands and behavior across all your projects.

Quality Gates

Enforces code quality before any release:

• Automatic linting with auto-fix
• TypeScript type checking
• Test execution with coverage
• Build verification

Smart Version Management

• Semantic versioning based on conventional commits
• Automatic changelog generation
• Git tagging with proper annotations
• Release notes generation

Flexible Deployment

• npm registry publishing
• Cloudflare Workers/Pages deployment
• GitHub releases with assets
• Extensible for custom targets

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📄 License

MIT © Go Corp

🆘 Support

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Discussions

Built with ❤️ for modern development teams