Release and Version History#

Backlog (TODO)#

Features and Improvements

  • prepare for the first API stable release.

Minor Improvements

Bugfixes

Miscellaneous

1.0.7 (2024-06-16)#

Minor Improvements

  • Add support for Python3.11 and 3.12.

Bugfixes

  • Fix a logging issue that won’t work in Python3.11 and 3.12.

Miscellaneous

  • Migrate to cookiecutter-pyproject@v4 code skeleton.

1.0.6 (2023-12-13)#

Minor Improvements

  • Add type hint using generic type for config_pattern.api.multi_env_json.BaseConfig and config_pattern.api.multi_env_json.BaseEnv.

1.0.5 (2023-12-12)#

Minor Improvements

  • The argument s3folder_config in config_pattern.api.multi_env_json.Config.deploy and config_pattern.api.multi_env_json.Config.delete method now can be a mapper of s3folder_config, so that you can use different S3 bucket folder for different environments.

1.0.4 (2023-12-04)#

Minor Improvements

  • The argument bsm in config_pattern.api.multi_env_json.Config.deploy and config_pattern.api.multi_env_json.Config.delete method now can be a mapper of bsm, so that you can use different AWS boto session for different environments.

Miscellaneous

  • Fix “Separate and Merge Non-Sensitive Data and Secret Data” document link.

1.0.3 (2023-12-01)#

Miscellaneous

  • Upgrade the aws_console_url from 0.x to 1.x.

1.0.2 (2023-06-01)#

Features and Improvements

  • add support to use version enabled S3 bucket as the backend.

  • now keep all historical versions of the config files in version not enabled S3 bucket.

  • add code_sha256 to the S3 object metadata for integrity check.

  • add api module to expose stable APIs to public.

Minor Improvements

  • rewrite the documents. Now the documents are more clear and easy to understand.

Bugfixes

Miscellaneous

1.0.1 (2023-05-17)#

Breaking Changes

  • 1.X.Y is not compatible with 0.X.Y at all.

  • The config json file schema is completely redesigned to embrace “inheritance hierarchy” and advanced “config merge” features.

Features and Improvements

  • Allow JSON path notation to apply shared config values.

  • Allow merging dict, list of dict, deeply nested dict or list of dict.

  • Add a hierarchy that implements “inheritance hierarchy” pattern, and can be used independently.

  • Add a py that implements “config merge” pattern, and can be used independently.

Miscellaneous

  • Update the example Jupyter Notebook.

0.4.1 (2023-05-12)#

Features and Improvements

  • the config_pattern.patterns.multi_env_json now support deploying to multiple AWS Account with different AWS profiles.

Minor Improvements

  • refactor the config_pattern.patterns.multi_env_json to make it more maintainable.

0.3.3 (2023-03-19)#

Minor Improvements

  • the config_pattern.patterns.multi_env_json.BaseConfig.deploy method now returns a list of config_pattern.patterns.multi_env_json.ConfigDeployment``deployment objects.

0.3.2 (2023-02-27)#

Minor Improvements

  • improve the error message when the config_pattern.patterns.multi_env_json.BaseConfig.get_env method failed due to the config definition and config data mismatch.

0.3.1 (2023-02-13)#

Minor Improvements

  • now depends on pysecret >= 2.2.2

Bugfixes

  • fix a bug that the bsm argument is missing

0.2.2 (2023-02-07)#

Bugfixes

  • fix a bug that multi environment json pattern cannot automatically prepend a prefix when project name starts with “aws” or “ssm”.

0.2.1 (2023-02-07)#

Features and Improvements

  • multi environment json pattern now can delete configs.

0.1.1 (2023-02-04)#

Features and Improvements

  • First release.

  • add multi environment json pattern.