Merge pull request #30 from GreenmaskIO/changelog_in_doc_v0.1.7

Changelog in doc v0.1.7
GreenmaskIO · Mar 15, 2024 · 4cf2864 · 4cf2864
2 parents 6af4717 + f62b3da
commit 4cf2864
Show file tree

Hide file tree

Showing 9 changed files with 398 additions and 167 deletions.
diff --git a/docs/assets/validate_horizontal_diff.png b/docs/assets/validate_horizontal_diff.png
diff --git a/docs/commands.md b/docs/commands.md
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -207,7 +207,11 @@ validate:
   rows_limit: 10 # (4)
   resolved_warnings: # (5)
     - "8d436fae67b2b82b36bd3afeb0c93f30"
-  format: "horizontal" # (6)
+  table_format: "horizontal" # (7)
+  format: "text" # (6)
+  schema: true # (8)
+  transformed_only: true # (9)
+  warnings: true # (10)
 ```
 { .annotate }
 
@@ -217,6 +221,10 @@ validate:
 4. Limits the number of rows to be transformed during validation. The default limit is `10` rows, but you can change it by modifying this parameter.
 5. A hash list of resolved warnings. These warnings have been addressed and resolved in a previous validation run.
 6. Specifies the format of the transformation output. Possible values are `[horizontal|vertical]`. The default format is `horizontal`. You can choose the format that suits your needs. See more details in the [validate command documentation](commands.md/#validate).
+7. The output format (json or text)
+8. Specifies whether to validate the schema current schema with the previous and print the differences if any.
+9. If set to `true`, transformation output will be only with the transformed columns and primary keys
+10. If set to then all the warnings be printed
 
 ## `restore` section
 

diff --git a/docs/custom-transformers.md b/docs/custom-transformers.md
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -3,7 +3,7 @@ site_name: Greenmask — PostgreSQL masking and obfuscation tool
 # Theme
 theme:
   name: material
-  custom_dir: overrides
+  custom_dir: docs/overrides
   logo: assets/logo.png
   favicon: assets/logo.png
   features:
@@ -113,10 +113,12 @@ nav:
               - Template: built_in_transformers/advanced_transformers/template.md
               - TemplateRecord: built_in_transformers/advanced_transformers/template_record.md
               - Custom functions:
-                - built_in_transformers/advanced_transformers/custom_functions/index.md
-                - Core custom functions: built_in_transformers/advanced_transformers/custom_functions/core_functions.md
-                - Faker function: built_in_transformers/advanced_transformers/custom_functions/faker_function.md
+                  - built_in_transformers/advanced_transformers/custom_functions/index.md
+                  - Core custom functions: built_in_transformers/advanced_transformers/custom_functions/core_functions.md
+                  - Faker function: built_in_transformers/advanced_transformers/custom_functions/faker_function.md
   - Release notes:
+      - Greenmask 0.1.7: release_notes/greenmask_0_1_7.md
+      - Greenmask 0.1.6: release_notes/greenmask_0_1_6.md
       - Greenmask 0.1.5: release_notes/greenmask_0_1_5.md
       - Greenmask 0.1.4: release_notes/greenmask_0_1_4.md
       - Greenmask 0.1.3: release_notes/greenmask_0_1_3.md

diff --git a/docs/overrides/main.html b/docs/overrides/main.html
@@ -1,5 +1,5 @@
 {% extends "base.html" %}
 
 {% block announce %}
-  Version 0.1.5 is released
+  Version 0.1.7 is <a href="https://github.com/GreenmaskIO/greenmask/releases/tag/v0.1.7">released</a>
 {% endblock %}
diff --git a/docs/release_notes/greenmask_0_1_6.md b/docs/release_notes/greenmask_0_1_6.md
@@ -0,0 +1,11 @@
+# Greenmask 0.1.6
+
+This is a minor release that introduces a bug hotfix
+
+## Fixes
+
+- Fixed uncontrolled buffer growth in the restore command
+
+## Assets
+
+To download the Greenmask binary compatible with your system, see the [release's assets list](https://github.com/GreenmaskIO/greenmask/releases/tag/v0.1.6).
diff --git a/docs/release_notes/greenmask_0_1_7.md b/docs/release_notes/greenmask_0_1_7.md
@@ -0,0 +1,48 @@
+# Greenmask 0.1.7
+
+This release introduces a new Greenmask command, improvements, bug fixes, and documentation update.
+
+## New features
+
+* Added restoration filtering by `--table`, `--schema` and `--exclude-schema` parameters
+* Validate parameters without parameters validates only configuration file
+* Added the `--schema` parameter, which allows to make a schema diff between the previous dump and the current. This 
+  is useful when you want to check if the schema has changed after the migration. By controlling it we can exclude 
+  data leakage after migration
+* Validate command divided by many stages that can be controlled using parameters
+    * Configuration validation
+    * Transformer validation
+    * Constraint violation check
+    * Data difference check
+
+
+## Improvements
+
+* Improved Hash transformer 
+    * Added salt parameter that can be set via config or via `GREENMASK_GLOBAL_SALT`
+    * Added sha3 functions support in different modes (sha3-224, sha3-256, sha3-384, sha3-512)
+* Refactored `Cmd` transformer logic
+    * Json API: Now it allows to use of column names instead of column indexes in JSON format
+    * Csv API: Now it can use the column order from config via column remapping
+* The `validate` command was rewritten almost from scratch.
+    * New option `--transformed-only` - displays only columns that are transformed with primary key (if exists). This
+      allows to reduce the output data and make it more readable
+    * Implemented `json` format for output
+    * Added the `--table-format` parameter which is responsible for the `vertical` and `horizontal` table orientation.
+      This works only when `--format=text`
+    * Added the `--warnings` parameter, if it is specified then not only fatal-warnings will be displayed, but also
+      those with a lower severity
+
+## Fixes
+
+* Fixed `--use-list` option - now it applies toc entries according to the order in list file
+* Fixed `--use-list` option behaviour together with `--list-format` option (`json` or `text`). Now it
+  generates temporal list file in text format for providing it to the pg_restore call
+* Updated documentation according to the latest changes
+
+
+
+## Assets
+
+To download the Greenmask binary compatible with your system, see
+the [release's assets list](https://github.com/GreenmaskIO/greenmask/releases/tag/v0.1.7).
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -117,6 +117,8 @@ nav:
                 - Core custom functions: built_in_transformers/advanced_transformers/custom_functions/core_functions.md
                 - Faker function: built_in_transformers/advanced_transformers/custom_functions/faker_function.md
   - Release notes:
+      - Greenmask 0.1.7: release_notes/greenmask_0_1_7.md
+      - Greenmask 0.1.6: release_notes/greenmask_0_1_6.md
       - Greenmask 0.1.5: release_notes/greenmask_0_1_5.md
       - Greenmask 0.1.4: release_notes/greenmask_0_1_4.md
       - Greenmask 0.1.3: release_notes/greenmask_0_1_3.md