Skip to content

Latest commit

 

History

History
165 lines (105 loc) · 9.75 KB

CHANGELOG.md

File metadata and controls

165 lines (105 loc) · 9.75 KB

Change Log

0.2.0 (2023-12-09)

The primary objective of this release is to make the package configurable at run-time using standard environment variables and/or a .env file. While adding this feature we also took the step of creating a config.Settings class with significant data validation capability, mostly thanks to Pydantic.

Secondarily, we took steps to make this project conform to 12-factor methodology. We want to make this project more accessible to students and learners as an instructional tool while not adding undue code review workloads to anyone with merge authority for this project. To this end we've added several pre-commit code linting and code style tools as well as a quasi-standardized set of GitHub Actions CI/CD automations that manage pull requests and semantic releases.

Features

  • add a conf module that reads .env and environment variable overrides (fa66f75)
  • add a configurable SECURE_LOGGER_LOG_LEVEL defaulted to logging.default() (448f56b)
  • add decorator parameter log_level (411de9d)
  • add parameter validations to decorator. add a unit test (b33c98a)
  • add pydantic strong type checking to parameters (71c3a2c)

Commit and Release Details

  • Add a config.Settings class with Pydantic validations and ability to configure at run-time via bash environment variable and/or a .env file.
  • Add SecureLoggerConfigurationError exception class to raise exception in the event of any Pydantic and/or package data validation errors during configuration.
  • add log_level input parameter to decorator to allow customization of the log level on individual log entries.
  • Refactored setup.py to remove deprecated macOS functions.
  • Add a security policy
  • Add a contributor policy
  • Added README badges to report live status of unit tests and CI/CD. Converted README to markdown.
  • Add Dependabot and Mergify to periodically monitor and update PyPi and NPM requirements
  • Add pre-commit with codespell, black, flake8, isort, pylint, bandit, tox, prettier. Add built-in pre-commit hooks for code style and security.
  • Added the following Github Actions:
    • Automated unit testing on push
    • Auto-assign new Issues
    • Periodic automated patch releases after Dependabot runs
    • Pull request automation
    • Semantic release
    • Automated merge of main to dev branches
  • Add GitHub templates for Issue, Contributing, Funding, Pull Request
  • Add the following to the Makefile
    • Recognition of .env file
    • Scaffold multi platform support
    • Make lint
    • Make help

0.1.18 (2023-12-05)

Bug Fixes

0.1.17 (2023-11-14)

Bug Fixes

  • add regex expressions to correctly evaluate all possible values of version.py (1ac6246)
  • restore npx semantic-release logic in next branch (e8e4b1d)

0.1.16 (2023-11-14)

Bug Fixes

  • convert prerelease version to strict semantic equivalent (f463db5)
  • remove pre-commit (12c3da0)
  • set prerelease to true for next and nexst-major (b830102)

0.1.15 (2023-11-14)

Bug Fixes

  • add npx semantic-release --dry-run --no-ci (d0133ab)

0.1.14 (2023-11-14)

Bug Fixes

  • fix requirements path for semantic release (f2ad049)
  • must add next and next-major (7434ecf)

0.1.13 (2023-11-14)

Bug Fixes

  • long_description_content_type='text/x-rst' (d551597)

0.1.12 (2023-11-14)

Bug Fixes

  • refactor python code blocks using readme_renderer compliant directives (49a3423)

0.1.11 (2023-11-14)

Bug Fixes

  • CURRENT_VERSION was unassigned (528fa71)

0.1.10 (2023-11-14)

Bug Fixes

0.1.9 (2023-11-13)

Bug Fixes

  • have to skip CI automated unit tests when commit version.py (0e939c8)
  • refactor call to npx semantic-release (2c7d768)

0.1.8 (2023-11-13)

Bug Fixes

  • required upgrade to node 20.9.0 (756ea63)
  • required upgrade to node 20.9.0 (9bc8871)

0.1.7 (2023-11-13)

Bug Fixes

  • add missing package descriptors (72bc5b3)
  • correct path to python requirements (cdc0557)
  • fix calls to unit tests (9b98d18)
  • fix path to secure_logger (1d6a1d9)
  • move version.py to the root (da0beac)
  • remove reference to django migrations (e0a62be)

CHANGE LOG

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.

[0.1.6] (2023-04-26)

  • add Github Actions test workflow status to README

[0.1.5] (2023-04-26)

  • add automated unit testing

[0.1.4] (2023-04-26)

  • bug fix: make dict key evaluation case insensitive

[0.1.3] (2023-04-26)

  • rename serialized_masked_dict() to masked_dict2str() with backward compatibility
  • add defaults for indentation and log value redaction string message
  • add more tests
  • refactor documentation

[0.1.2] (2023-04-25)

  • add strong type checking

[0.1.1] (2023-04-25)

  • renamed to secure_logger

[0.1.0] (2023-04-14)

  • initial release