Skip to content

Latest commit

 

History

History
199 lines (172 loc) · 9.32 KB

changelog.md

File metadata and controls

199 lines (172 loc) · 9.32 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Released

0.10.1 - 2024-10-02

Fixed

  • add support for Python 3.11
  • update twine version to 5.1.1 or newer to fix KeyError issue
  • drop release testing with Python 3.7
  • yaml syntax is correct for all workflow files

0.10.0 - 2023-07-08

Added

  • --validate argument can be used to validate an existing version file against the latest changelog entry
  • RenderVersionFile provides a content property with the rendered file content after calling the render_file function
  • save_file parameter of render_file function can be used to only render, but not save content to file
  • pre-commit hook and config files

0.9.0 - 2022-11-12

Added

  • Version of changelog2version can be requested with --version argument, see #22
  • Verbosity of internal logger can be set with -vvvv as DEBUG, default level is CRITICAL, see #22
  • Usage example in README for description and version extraction from JSON in console, introduced in 0.7.0, see #20

0.8.0 - 2022-11-11

Added

  • Create release candidate tag and release on every pull request build. The release description is the latest changelog content, the release title is the latest changelog version. The release is marked as pre-release, see #18

0.7.0 - 2022-11-11

Added

  • Changelog parsed as JSON contains a new key description like the PyPi package JSON info, compare to https://pypi.org/pypi/changelog2version/json, with the description/content of the latest change, see #19, relates to #18
  • Increase unittest coverage above 95%

Changed

  • Line breaks are no longer used in this changelog for enumerations
  • Issues are referenced as #123 instead of [#123][ref-issue-123] to avoid explicit references at the bottom or some other location in the file
  • Output of changelog2version call with --print but without --debug option is JSON compatible

0.6.0 - 2022-10-26

Added

  • Changelog can be parsed as JSON file with a similar format as the pypi package JSON info available at https://pypi.org/pypi/PACKAGENAME/json, see #16 The new option --output writes the data in JSON valid format to a file specified file, --print flag sends the data in JSON valid format to sys.stdout. In both cases --pretty flag can be set to output the data with an indentation of 4.

Changed

  • --version_file argument is optional in order to allow a JSON output only

0.5.0 - 2022-10-20

Added

  • Support additional version info file content in python version files by adding the content given by --additional_version_info="-rc1234" to the end of the constructed __version__ content. This will create the following line in a version.py file: __version__ = '.'.join(__version_info__) + '-rc1234' A created package will thereby be named 0.5.0rc1234 if the version is 0.5.0, resolve #14

0.4.0 - 2022-08-07

Added

  • Property semver_data to access extracted VersionInfo from parsed semver line in ExtractVersion class
  • Header and python version template file
  • RenderVersionFile class to render template files with provided content, resolve #5
  • Examples folder with example C script to demonstrate template rendering on other files than python
  • --template_file argument to specify a custom template file for rendering
  • --additional_template_data to add custom data for the template rendering
  • c is now a valid and supported file type of --version_file_type
  • Documentation extended for new CLI args with more detailed examples
  • Jinja2 is a required package for this package

Changed

  • parser_valid_file function returns a resolved path
  • --version_file_type is no longer case sensitive
  • --version_file does no longer have to exist
  • Run GitHub CI unittest workflow also on pull requests

Removed

  • Functions to update python version files from update_version.py script

Fixed

0.3.0 - 2022-08-05

Changed

  • Regex to extract the first version line from a changelog supports the full feature scope of semantic versioning, resolve #8
  • Regex to get the semantic versioning content of a version line supports the full feature scope of semantic versioning, resolve #8
  • Testing of this package with nose2 and coverage report generation with coverage including upload to Codecov was moved to new GitHub CI unittest workflow, resolve #11

Removed

0.2.0 - 2022-08-03

Added

  • ExtractVersion class to extract the version line from a changelog file and to parse the semver content from a version line, resolve #4
  • semver_line_regex and version_line_regex args for changelog2version to provide custom regular expressions to parse a version line from a changelog and to extract the semver content from a line

Changed

0.1.1 - 2022-07-31

Fixed

0.1.0 - 2022-07-31

Added

Changed

Removed

  • Sample package in src after fork
  • Sample package test in tests after fork
  • Data folder after fork