shipi | docs

Audiences

Shipi can generate release notes for different audiences. Each audience gets a different level of detail and tone.

Available audiences

AudienceDescriptionBest for
changelogCustomer-facing, polishedPublic release notes
internalTechnical details, ticket refsDev teams, QA
executiveHigh-level summaryStakeholders, PMs

Usage

shipi generate --audience changelog

Examples

changelog (default)

shipi generate --audience changelog

Output:

## v2.4.0

- Added dark mode toggle in settings
- Search results now load 2x faster
- Fixed Safari login redirect bug

internal

shipi generate --audience internal

Output:

## v2.4.0 - Internal

### Features
- Implemented ThemeContext with localStorage persistence
- Refactored SearchService to use Elasticsearch aggregations

### Bug Fixes
- AUTH-421: Fixed OAuth callback handling for Safari ITP
- PERF-89: Resolved N+1 query in user dashboard

executive

shipi generate --audience executive

Output:

## v2.4.0 Summary

This release improves user experience with dark mode support
and faster search. One authentication bug was resolved.

**Impact:** Improved user satisfaction, reduced support tickets.