Skip to content

ReleasePilot

ReleasePilot

ReleasePilot – Audience-Aware Release Notes Generator

Polished release notes from any git repo, in seconds.

CLI Developer Tool
CI Version License Stars Issues Last Commit
5
Output Formats
590+
Tests
10
Output Languages
8
Target Audiences

About

ReleasePilot is an open-source Python CLI tool that reads your git history and generates beautiful, audience-tailored release notes. It supports eight target audiences — developers (technical changelog), executives (business summary), and end-users (What's New). Output formats include Markdown, Plain Text, JSON, PDF, and DOCX — with professionally typeset narrative PDF featuring statistics, breaking changes, and security sections. The guided interactive workflow walks you through every option: repository, branch, time range, audience, format, language, and custom titles. Supports 10 output languages (EN, PL, DE, FR, ES, IT, PT, NL, UK, CS), conventional commit detection, intelligent deduplication, and a modular pipeline architecture for extensibility.

Key Features

01

Guided Interactive Workflow

Step-by-step CLI wizard walks you through every option — repository, branch, time range, audience, format, language, and custom headings. No config files needed.

02

Audience-Aware Output

Generate developer changelogs, executive summaries, or user-facing What's New notes — each with tailored tone, structure, and level of detail.

03

Narrative PDF Reports

Markdown, Plain Text, JSON, PDF, and DOCX output. Narrative PDF includes cover page, statistics dashboard, breaking changes section, and branded footer.

04

10 Output Languages

Generate release notes in English, Polish, German, French, Spanish, Italian, Portuguese, Dutch, Ukrainian, and Czech — with proper localization of structural headings and labels. Content translation available via optional deep-translator package.

05

Conventional Commit Detection

Automatically categorizes commits by type — features, fixes, breaking changes, performance, security, docs — using conventional commit prefixes.

06

Intelligent Deduplication

Filters out noise, merge commits, and duplicate entries. Groups related changes for clean, readable output.

07

Pipeline Architecture

Modular collect → filter → compose → render pipeline. Easy to extend with custom stages, formatters, or output targets.

08

Five Output Formats

Professional multi-page PDF with executive overview, feature highlights, reliability metrics, security notes, statistics dashboard, and branded styling.

How It Works

Install with pip, then run the guided workflow — it walks you through every option and generates polished release notes in seconds.

Privacy & Security

Your code stays on your machine. Everything runs locally.

100% Local Processing No Telemetry No Account Required Open Source (MIT) Zero External APIs

Product Info

  • Output Formats5
  • Tests627
  • Output Languages10
  • Python3.12+
  • OutputMarkdown, TXT, JSON, PDF, DOCX
  • PublisherPOLPROG
  • LicenseMIT
  • PriceFree

Install

Via pip (Recommended):
pip install releasepilot
Quick Start:
releasepilot guide path/to/repo