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.9.1 - 2026-05-04

Fixed

  • Update brainelectronics/changelog-based-release action to v1.2.2 to create tag of PR on head of branch

0.9.0 - 2026-05-01

Changed

  • Machine readable JSON of failed validation diff is printed to stderr instead of stdout to be usable with upy-package ... --validate [--debug -vvvvv] 2> >(jq -r '.values_changed') even if debug logging is enabled

Fixed

  • Print new line after pretty printed diff on failed validation

  • Install package as additional dependency to run nose2 tests

0.8.0 - 2026-05-01

Added

  • Extended documentation for pre-commit installation and usage

  • nose2 pre-commit hook

  • Extend logging usage for better debugging with cleaner log messages

  • requirements-deploy-lock.txt capturing the current dependency package versions used

Changed

  • Updated pre-commit hook versions of flake8 and yamllint

  • Using --pretty provides a better human readable diff output

  • Instead of finally raising a SystemExit if the validation failed, the message is printed to stderr before writing the diff to stdout.

  • The message of a mismatch between setup.py and package JSON file data is only printed when using --pretty to make the output machine readable.

  • The diff of the validation is returned with verbose level 2

Fixed

  • Add missing type and parameter docstring for package_file_glob in Setup2uPyPackage

0.7.0 - 2026-04-28

Added

  • The CLI arg --package_file_glob allows using a different glob pattern than the default *.py for adding package files from within the directory specified at packages in setup.py. For a mpy-cross compiled package the arg --package_file_glob should be set to *.mpy

  • Add debug log messages to validate function

0.6.1 - 2026-04-28

Fixed

  • Raise a FileNotFoundError if the specified package_file is not found during validation. The file will be created with the --create option without throwing an error due to non-existance on CLI arg parsing level.

0.6.0 - 2026-04-27

Added

  • .python-version to use repo this with pyenv

Changed

  • Bump all package versions to their latest version supporting Python 3.9

  • Mention Python 3.11 and 3.12 support in setup.py

Fixed

  • Silence all yamllint warnings

0.5.1 - 2026-04-27

Fixed

  • This change creates the correct release candidate number based on the action run of a pull request workflow run test-release instead of the total number of this workflow run. By this fix, the -rcX metadata starts at 1 and is incremented with every push, no matter if the push is a force push or a classic new commit on top in a ongoing pull request.

  • Update external action versions to latest available version

  • Fix license specification in setup.py file

  • Check all files in dist/, not only *.tar.gz

0.5.0 - 2023-07-05

Added

  • pre-commit hook and config files

Fixed

  • Added missing empty line in several files

0.4.0 - 2023-06-10

Added

  • */boot.py and */main.py can be ignored during the check with --ignore-boot-main, see #8

0.3.0 - 2023-05-27

Added

  • Dependencies of package can be ignored during the check with --ignore-deps, see #5

0.2.0 - 2023-05-27

Added

  • Version of package can be ignored during the check with --ignore-version, see #4

0.1.1 - 2023-04-18

Fixed

  • Sort URL list elements before comparing package.json and returned setup.py data, see #2

0.1.0 - 2023-03-27

Added

  • setup2upypackage module

  • Examples and documentation

  • Unittest files

Changed

  • Several updates on setup and config files different than the template repo

Removed