release: 0.7.0 #16
Merged
release: 0.7.0 #16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added a new `_apply_masking` function to centralize masking logic for sensitive data. - Updated existing report display functions to utilize the new masking function, improving code readability and maintainability. - Adjusted type hints for better clarity in the `_resolve_masking_config` function.
- Replaced direct calls to `mask_sensitive_data` with the new centralized `_apply_masking` function for improved consistency in handling sensitive data. - Updated the logic for applying masking to output values and processed summaries, enhancing code readability and maintainability.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces release 0.7.0 with a major new feature for security-focused output masking. The changes add comprehensive masking functionality across deployment outputs, reports, pipeline summaries, and documentation while enhancing tests, AWS utility functions, and documentation content.
- Adds support for output masking via new configuration in PipelineSettingsModel.
- Implements masking functions for various AWS resource identifiers and tests their integration.
- Updates documentation and styling to reflect the new security masking features.
Reviewed Changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_pipeline_models.py | Updated model instantiation and testing for alias handling with masking outputs. |
| tests/test_integration_masking.py | Added comprehensive integration tests for output masking. |
| tests/test_aws_utils.py | Added extensive tests for each individual masking helper in aws_utils. |
| samstacks/reporting.py | Integrated masking resolution into console and markdown report generation. |
| samstacks/pipeline_models.py | Added models for output masking configuration. |
| samstacks/core.py | Updated report display and stack output processing to apply masking. |
| samstacks/aws_utils.py | Overhauled masking functions to support various AWS resource formats. |
| Documentation files (README, docs/*, CHANGELOG) | Updated documentation to reflect the new security-focused masking feature. |
| docs/assets/css/custom.css | Minor style improvements for hero section with adjusted background properties. |
| examples/* | Pipeline and sample configuration updates to showcase security masking. |
- Added TODO comments in `mask_account_id` and `mask_ip_addresses` functions to consider using named pattern variables and a more comprehensive IPv6 regex, respectively. These changes aim to enhance code maintainability and robustness against future modifications.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a major new feature: Security-Focused Output Masking, aimed at enhancing sensitive data protection across deployment outputs, reports, and logs. It also includes updates to documentation and examples to showcase this feature, along with minor styling and functionality improvements.
Security Features
output_maskingconfiguration inpipeline_settingsto automatically mask sensitive data such as AWS account IDs, API endpoints, database URLs, and more. Includes seven built-in masking categories, support for custom regex patterns, and per-pipeline configurability. [1] [2] [3] [4]Documentation Enhancements
examples/README.mdto include security-focused output masking in pipeline demonstrations, along with deployment instructions and masking configurations.Styling and Functionality Improvements