changelog-tool

Validates CHANGELOG.md and ensures it conforms to the Common Changelog style.

# Changelog

main-note (optional)

## [Unreleased]

### Fixed

- fix 1

## [0.2.0] - 2024-02-01

### Added

- change 1
- change 2

## [0.1.0] - 2024-01-01

initial release

[Unreleased]: https://github.com/user/project
[0.2.0]: https://github.com/user/project/releases/tag/0.2.0
[0.1.0]: https://github.com/user/project/releases/tag/0.1.0

where:

• h2 header starts Release section
• Release name is ether:
  • [Unreleased]
  • [SemVer] - YYYY-MM-DD
• Release may contain a release note and a list of changes, grouped by type
• h3 header starts Change Type section
• Change type is one of Added, Changed, Fixed or Removed
• Change is an one line text, starting with -

Usage

Create config file and verify that urls are correct

changelog-tool init

Add 'Unreleased' section

changelog-tool new

Add some changes to CHANGELOG.md

Create new release

changelog-tool release 0.1.0

Verify CHANGELOG.md

changelog-tool check

Installation

TBD