Metadata-Version: 2.3
Name: changelog-tool
Version: 1.0.1
Summary: Validates CHANGELOG.md format
Author: Anatoly Asviyan
Author-email: Anatoly Asviyan <anatoly@mail.com>
License: The MIT License (MIT)
         
         Copyright (c) 2021 Anatoly Asviyan <aanatoly@gmail.com>
         
         Permission is hereby granted, free of charge, to any person obtaining a copy of
         this software and associated documentation files (the "Software"), to deal in
         the Software without restriction, including without limitation the rights to
         use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
         the Software, and to permit persons to whom the Software is furnished to do so,
         subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
         FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
         COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
         IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
         CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Requires-Dist: pytest>=7.0 ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Python: >=3.12
Provides-Extra: dev
Description-Content-Type: text/markdown

# changelog-tool

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

```markdown
# 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

```bash
changelog-tool init
```

Add 'Unreleased' section

```bash
changelog-tool new
```

Add some changes to CHANGELOG.md

Create new release

```bash
changelog-tool release 0.1.0
```

Verify CHANGELOG.md

```bash
changelog-tool check
```

## Installation

TBD

[SemVer]: https://semver.org/spec/v2.0.0.html
[Common Changelog]: https://common-changelog.org/ "Common Changelog"
