Skip to main content

Validates CHANGELOG.md format

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

changelog_tool-1.0.1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file changelog_tool-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: changelog_tool-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for changelog_tool-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0a947af6dd46fafaa1096729e9722080ba013ad54449c9fee758d700fea56e28
MD5 4899d2741538292ab997c2e6beaf5365
BLAKE2b-256 4a20e93347ddaa99def86846270ea24e72c205c9fb436c97375e75277a0655e7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page