release-pilot

ReleasePilot

AI-powered release management CLI for software projects using conventional commits.

Features

• Automatic Version Calculation: Determines semantic version bumps from conventional commits
• AI-Powered Release Notes: Generates professional changelogs and release notes using OpenAI
• Plugin System: Extensible via gRPC plugins (GitHub releases, npm publish, Slack notifications)
• Approval Workflow: Review and approve releases before publishing
• Interactive CLI: Guided setup and approval process with beautiful terminal output
• Dry Run Mode: Preview changes without making any modifications

Installation

Using Go

go install github.com/felixgeelhaar/release-pilot/cmd/release-pilot@latest

From Source

git clone https://github.com/felixgeelhaar/release-pilot.git
cd release-pilot
go build -o release-pilot ./cmd/release-pilot

Docker

docker pull ghcr.io/felixgeelhaar/release-pilot:latest

Quick Start

1. Initialize ReleasePilot in your project:

release-pilot init

1. Plan a release (analyzes commits since last tag):

release-pilot plan

1. Generate release notes (optionally with AI):

release-pilot notes --ai

1. Approve the release:

release-pilot approve

1. Publish the release:

release-pilot publish

Configuration

Create a release.config.yaml in your project root:

versioning:
  strategy: conventional
  tag_prefix: v
  git_tag: true
  git_push: true

changelog:
  file: CHANGELOG.md
  format: keep-a-changelog
  repository_url: https://github.com/your-org/your-repo

ai:
  enabled: true
  provider: openai
  model: gpt-4
  tone: professional
  audience: developers

plugins:
  - name: github
    enabled: true
    config:
      draft: false
  - name: slack
    enabled: true
    config:
      webhook: ${SLACK_WEBHOOK_URL}

workflow:
  require_approval: true
  allowed_branches:
    - main

Commands

Global Flags

Environment Variables

Conventional Commits

ReleasePilot follows the Conventional Commits specification:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Types and Version Bumps

Plugins

ReleasePilot supports plugins for extending functionality:

GitHub Plugin

Creates GitHub releases with release notes:

plugins:
  - name: github
    config:
      draft: false
      prerelease: false

npm Plugin

Publishes packages to npm registry:

plugins:
  - name: npm
    config:
      access: public
      registry: https://registry.npmjs.org

Slack Plugin

Sends release notifications to Slack:

plugins:
  - name: slack
    config:
      webhook: ${SLACK_WEBHOOK_URL}
      notify_on_success: true
      notify_on_error: true

Architecture

ReleasePilot is built with Domain-Driven Design principles:

├── cmd/release-pilot/     # CLI entry point
├── internal/
│   ├── application/       # Use cases
│   ├── domain/           # Business logic
│   │   ├── changes/      # Commit analysis
│   │   ├── release/      # Release aggregate
│   │   └── version/      # Semantic versioning
│   ├── infrastructure/   # External adapters
│   ├── cli/              # Command implementations
│   └── service/          # Application services
├── pkg/plugin/           # Plugin interface
└── plugins/              # Official plugins

Development

Prerequisites

• Go 1.22+
• Git

Build

make build

Test

make test

Lint

make lint

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes using conventional commits
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

MIT License - see LICENSE for details.