Release created on: 18.07.2024 - 06:26:11

This mainly deals with platform issues since v0.14.0 on GitHub Actions.

v0.16.3

New Features

None

Changes

None

Bug Fixes

• Disbaled some tests for strange GitHub Action behavior.

v0.16.2

New Features

None

Changes

• Bumped dependencies.

Bug Fixes

• Renamed first parameter in classmethod to cls.

v0.16.0

New Features

None

Changes

• Bumped dependencies.

Bug Fixes

• Remove basic authentication credentials from repository URLs.

Documentation

• Fixed installation instructions.

v0.15.0

New Features

• Implemented new field command to return a single value.
  Requested by @navidcity in #19.
• Updated documentation:
  • Restructured sections
  • Added lots of doc-strings.
  • Listed supported CI services / platforms.
  • Listed supported VCS.
  • Listed supported languages (all).
  • Auto document command line interface from ArgParse configuration (autoprogram).
  • Listed C example.
• Added new VersioningException and ToolException.

Changes

• Bumped dependencies.
• Improved exception messages.
• Renamed GitHelper to GitHelperMixin.
• Updated list of dependencies.
• Updated installation instructions.
  • Included instructions on how to run unit tests, code coverage and type checking.
• Refactored configuration classes from nested classes to normal classes in a module.

Bug Fixes

• Fixed testcases.

Related issues:

• Closes #19

/cc @navidcity

Release created on: 17.06.2024 - 05:23:13

New Features

None

Changes

• Bumped dependencies.

Bug Fixes

• Print fatal error in case of syntax error in the template.
• Fixed fields in C example template.

CI Pipeline

• Run C example in pipeline and compile an example application.

Release created on: 16.06.2024 - 22:47:36

New Features

• Added CLI flags -v/--verbose and -d/--debug.
• Added more verbose and debug messages.
  • Enabled quiet mode automatically, if no output file parameter given.
• Added CLI option --config-file for all commands.
  See #18.
  • Allow a user defined .pyVersioning.yml location.
  • Fall back to predefined .pyVersioning.yml file in working directory.
• Added optional CLI argument <output file> to command json.
• Added optional CLI argument <output file> to command yaml.

Changes

• Bumped dependencies.
• Made CLI argument <output file> optional.
  • If not present, the content is written to STDOUT and quiet mode is activated to avoid further program outputs.

Bug Fixes

• Fixed type annotations.
• GHA: Fixed project name in Pipeline.yml

Unit tests

• Added new unit tests for verbose and debug outputs.
• Added new unit test for command fillout to check output to stdout.
• Added new unit test for command json to check the written output file.
• Added new unit test for command yaml to check the written output file.
• Improved printing of stdout and stderr.
• Refactored test code to remove duplications.

/cc @navidcity

Release created on: 24.04.2024 - 05:44:07

New Features

None

Changes

• Bumped dependencies.

Bug Fixes

None

Release created on: 10.04.2024 - 21:38:21

New Features

None

Changes

• Bumped dependencies.

Bug Fixes

• Adjusted usage of SematicVersion's constructor to the new use model of pyTooling.
  (Undocumented overload resolution feature was removed from meta-class. See also v6.1 release notes.)

Release created on: 19.01.2024 - 07:00:05

New Features

None

Changes

None

Bug Fixes

• Reactivated application tests in pipeline.

Release created on: 17.01.2024 - 20:50:18

New Features

None

Changes

• Bumped dependencies.
  • Updated to pyTooling v6.0.0 and applied new features and API changes.
• Updated pipeline description.

Bug Fixes

• Added missing type hints.
• Changed exit calls to raise Exception.

Unit tests

• Readback output from JSON command and parse JSON string.
• Readback output from YAML command and parse YAML string.

Documentation

• Change Sphinx build flow from BuildTheDocs to Sphinx with ReadTheDocs v2.0 theme.
• Show documentation coverage via sphinx_reports..
• Show code coverage via sphinx_reports.
• Show testcase summary via sphinx_reports.

Release created on: 15.08.2023 - 22:53:36

New Features

• Added after-installation unit tests.
  • Added new pipeline step to install packaged code and run CLI commands.

Changes

• Adjusted naming style: Methods are in UpperCamelCase.
• Reorganized classes in packages.
• Removed usage of @dataclass.
• Added type hints.
• Bumped dependencies.
• Doc: Documented the dependency to typing-extensions.

Bug Fixes

• Renamed all method names from get... to Get....
• Further adjustments to pyTooling v5.0.x.
• Doc: Fixed InterSphinx configuration.

Related Issues and PRs

• #15

/cc @kaiteu, @navidcity

Automated Release created on: 15.07.2023 - 15:57:24

New Features

• tbd

Changes

• tbd

Bug Fixes

• tbd

Automated Release created on: 14.02.2023 - 00:11:51

New Features

• tbd

Changes

• tbd

Bug Fixes

• tbd

Release created on: 08.02.2023 - 21:29:24

New Features

• Marked abstract methods with @abstractmethod.
• Marked classes with @export for automated documentation feature.
• New method abstracting git show ....

Changes

• Bumped dependencies.
  • Fixed incompatibility with pyTooling v2.x due to changes in metaclasses.
• Replaced dependency to py-flags with builtin Enum class.
• Updated pyTooling/Actions to use dev branch releases.
  This enables Python 3.11 testing.
• Updated copyrights and file headers.
• Removed overloaded methods for __init__ in Application.
• Changed single-quote strings to double-quote strings.
• Converted "...".format(...) to f-strings.
• Enhanced pyproject.toml.

Bug Fixes

• Remove init values on class level.
• Fixed type hints especially of nullable parameters.
• Added missing field build in case no configuration file was found.
• Convert returned UNIX timerstamp to a datetime.

Known Issues

• Sphinx is limited to <v6.0.0

Release created on: 10.01.2022 - 20:59:35

New Features

None

Changes

• Use new pyTooling package.
• Use a workflow based on pyTooling.Actions
  • Check static typing.
  • Publish unit test results.
  • Publish documentation to GH Pages.
• Changed documentation build flow from ReadTheDocs to BuildTheDocs.
• Added dependabot config file.
• Updated gitignore
• Updated requirement files.
• Reworked file headers.
• Merged .coveragerc and pytest.ini into pyproject.toml

Bug Fixes

None

Stable on local builds, but needs testing on different CI platforms.

This pre-release has basic supports for:

• AppVeyor
• GitHub
• GitLab
• Travis
• a local Git