communiquéGenerate release notes from your repository
Communiqué uses an AI model to read commits, pull requests, and source changes, then draft release notes. Review the output locally, write a changelog entry, or publish to GitHub Releases.
Skip to content
Generate a draft
Run communique init to create a configuration file, then generate notes for a release tag. Communiqué compares it with the previous tag and lets the model inspect repository files and diffs for context. GitHub access adds pull request details to that context.
sh
communique generate v1.2.0 --draft release.jsonYou need an API key for Anthropic or an OpenAI-compatible provider. Configure the model, project context, and writing style in communique.toml.
Review before publishing
The saved draft is editable. Preview your changes locally, then publish the reviewed draft without invoking the model again.
sh
communique publish release.json --dry-run
communique publish release.jsonGeneration can also produce a coverage report and migration guide to help you review what changed and what users need to do when upgrading.
Configure review and output options
Update a changelog or GitHub Release
Use --changelog when generating to write a version entry to CHANGELOG.md, or --github-release to publish directly to a GitHub Release. Add --concise when you want a shorter summary. You can run these commands locally or in a release workflow.