Skip to content

Latest commit

 

History

History
151 lines (126 loc) · 6.37 KB

changelog.md

File metadata and controls

151 lines (126 loc) · 6.37 KB

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.0 - 2023-07-11

Added

  • Precommit hooks for package.json and package version file validation, yaml style, flake8 and trailing whitespace checks
  • Contribution guideline
  • Package version file validation step in test workflow

Fixed

  • Added missing empty line in several files

0.8.1 - 2023-06-12

Fixed

  • Usage documentation with more comments and WiFi instructions in root README
  • Installation of latest available package version with upip mentioned in root README
  • Available package validation options added as comment to test workflow

0.8.0 - 2023-03-29

Added

  • Add MicoPython as Implementation in setup classifiers, see #16
  • Verify package.json against latest changelog and setup in test workflow, see #17

0.7.0 - 2023-03-17

Added

  • Set settings for JSON files to use an indentation of 4 in .editorconfig
  • package.json for mip installation with MicroPython v1.19.1 or newer
  • Instructions for installation with mip on MicroPython v1.19.1 or newer in README
  • Instructions to be performed after using this template package in README
  • Example files for boot and main

Changed

  • Omit package version file from coverage calculation in .coveragerc
  • Run test workflow also on pull requests
  • Update date of license to 2023

Removed

  • No longer used update_version.py file removed from flake8 exclude list

Fixed

  • Path to documentation build output folder is only highlighted to avoid broken links errors
  • Mock commonly used MicroPython specific modules in docs config file

0.6.0 - 2023-02-22

Added

  • .editorconfig for common editor settings, see #12
  • .yamllint to lint all used YAML files, see #12
  • codecov.yaml to specify further settings and limits for the coverage
  • yamllint package to the requirements-test.txt file
  • Run YAML linter on test workflow

Changed

  • Fixed uncovered YAML syntax issues in all workflow files
  • Removed unused files from .gitignore file

0.5.0 - 2023-02-20

Added

  • .readthedocs.yaml definition file for ReadTheDocs, see #10
  • docs folder containing example files and configurations, see #10

0.4.0 - 2023-02-20

Added

  • test-release and release workflows create changelog based (pre-)releases, see #2
  • Documentation for manually creating a package and uploading it to PyPi in root README

Fixed

  • All workflows use checkout v3 instead of v2

0.3.0 - 2022-11-03

Added

Fixed

  • Remove not required packages setuptools, wheel and build from release and test-release workflow files
  • Show download of this package on badge instead of be-modbus-wrapper
  • Show MicroPython Ok badge instead of Python3 Ok in README

0.2.0 - 2022-10-22

Added

Changed

  • Built artifacts are no longer archived by the always running test workflow

0.1.1 - 2022-10-16

Fixed

  • Move src/be_upy_blink to be_upy_blink to avoid installations into /lib/src/be_upy_blink on a uPy board via upip, see #3
  • Adjust all paths to be_upy_blink folder and contained files

0.1.0 - 2022-10-16

Added