2.0.0 (2024-06-14)

Removed

• Python 3.7 and 3.8 are not supported anymore.

Added

• Python 3.12 is now explicitly supported.

Fixed

• Uncategorized change (usually comments) will no longer impact the release version.
• Typing is using built-in types for tuple, list and dict consistently.

Changed

• keepachangelog.starlette.add_changelog_endpoint is now keepachangelog.starlette.changelog_endpoint. Refer to documentation for more details.

2.0.0.dev5 (2023-01-03)

Changed

• keepachangelog show does not support --raw option anymore. It will always be the raw markdown output.
• keepachangelog release will now fail if there is nothing to release.

Removed

• keepachangelog show does not support --raw option anymore.

2.0.0.dev4 (2022-12-22)

Added

• Add a CLI to interact with keepachangelog API. (Thanks Luca Faggianelli)

Changed

• Changelog file is now expected to be utf-8 encoded when read. (Thanks 0x55aa)
• Changelog file is now utf-8 encoded when written.

2.0.0.dev3 (2022-10-19)

Fixed

• keepachangelog.from_dict now returns a single new line at end of file in case no url could be found. (Thanks rockstarr-programmerr)

Changed

• Dropped support for python 3.6

2.0.0.dev2 (2021-08-04)

Fixed

• keepachangelog.release will now properly bump version in case the number of digit to compare was previously increased (such as if version 9 and 10 existed).

Added

• keepachangelog.to_sorted_semantic to be able to sort semantic versions.

2.0.0.dev1 (2021-05-27)

Changed

• keepachangelog.release will now return None instead of throwing an exception if there is no Unreleased content.

2.0.0.dev0 (2021-05-27)

Fixed

• keepachangelog.to_dict now contains releases that have a URL but no section.
• keepachangelog.to_raw_dict now contains releases that have a URL but no section.

Changed

• keepachangelog.to_dict now contains uncategorized key for each item if uncategorized information are available for the version.
• keepachangelog.to_dict now contains metadata key where version, release_date, semantic_version and url have been moved.
• keepachangelog.to_raw_dict now contains metadata key where version, release_date, semantic_version and url have been moved.
• As keepachangelog.starlette.add_changelog_endpoint is returning data as returned by keepachangelog.to_dict, the endpoint output is now modified.
• As keepachangelog.flask_restx.add_changelog_endpoint is returning data as returned by keepachangelog.to_dict, the endpoint output is now modified.

Added

• keepachangelog.from_dict to create a changelog content based on a dictionary.
• keepachangelog.to_dict now allows to provide any line iterable instead of only a file path.

1.0.0 (2021-05-21)

Changed

• keepachangelog.to_dict now contains url key for each item if a link is available for the version.
• keepachangelog.to_raw_dict now contains url key for each item if a link is available for the version.
• keepachangelog.to_dict now contains semantic_version key for each item if the version follows semantic versioning.
• keepachangelog.to_raw_dict now contains semantic_version key for each item if the version follows semantic versioning.

Added

• keepachangelog.release is now allowing to provide a custom new version thanks to the new new_version parameter.

Fixed

• keepachangelog.release now allows pre-release and build metadata information as part of valid semantic version. As per semantic versioning specifications.
  To ensure compatibility with some python specific versioning, pre-release is also handled as not being prefixed with -, or prefixed with ..
• keepachangelog.release will now bump a pre-release version to a stable version. It was previously failing.

0.5.0 (2021-04-19)

Added

• keepachangelog.release function to guess new version number based on Unreleased section, update changelog and return new version number.
• keepachangelog.to_raw_dict function returning a raw markdown description of the release under raw dict.

Fixed

• Handle any category name.
• Add more flexibility for release format.

Changed

• Unreleased is now reported as lower cased unreleased.

0.4.0 (2020-09-21)

Added

• keepachangelog.flask_restx.add_changelog_endpoint function to add a changelog endpoint to a Flask-RestX application.