Overview
A Flutter/Dart library for managing CHANGELOG.md files, enabling reading, modifying, and writing changelogs with ease. Inspired by the keepachangelog.com standard, it helps maintain consistent and structured release notes. The package supports parsing existing changelogs and generating new entries, making it ideal for automated release workflows. It works across all major platforms, including mobile, web, and desktop, ensuring seamless integration into CI/CD pipelines and development tools.
Use cases
- Automating release note generation
- Maintaining consistent changelog format
- Integrating changelog updates into CI/CD
- Updating release notes programmatically
- Parsing and validating changelog content
Key features
- Parse and write CHANGELOG.md files
- Support for keepachangelog.com format
- Cross-platform compatibility
- Simple API for adding/changing entries
- Robust error handling for malformed changelogs
Suitable for
- Development teams using version control
- CI/CD pipeline integrations
- Tools that generate release notes
- Projects following semantic versioning
- Maintainers of open-source packages
Considerations
- Requires manual setup for initial changelog structure
- Does not auto-generate version numbers
- Best used with existing changelog files
- Limited to text-based changelog manipulation
- No built-in support for markdown formatting beyond basic syntax