-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feature(tool): Implementation of the Appsettings files linter #11
Merged
Conversation
This file contains 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
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.
Appsetings Linter implementation
Description:
The current pull request proposes the implementation of an AppSettings Linter. This feature aims to improve the reliability and overall quality of application configuration files.
Motivation:
The configuration files play a crucial role in defining how applications behave in various environments. However, with increasing complexity, it's becoming challenging to keep track of all the setting definitions and potential errors. This often leads to unexpected issues, and difficulties in debugging.
Proposed Solution:
The AppSettings Linter is designed to tackle these challenges head-on. It will be a tool that scans the appsettings.json files for potential issues, inconsistencies, and adherence to the Stratio Vault Library syntax requirements. The linter will ensure that the configurations are correctly structured, appropriately typed, and free from common mistakes that might lead to runtime errors or security risks.
Implementation Details:
The AppSettings Linter is developed as a standalone utility using python. It can be integrated into CI/CD pipelines and run automatically during code reviews and deployments. A Docker image will also be implemented to improve an easier adoption of this tool.
Testing:
To ensure the reliability of the linter, comprehensive unit tests and integration tests will be created to cover various scenarios and edge cases.
Expected Impact:
By implementing the AppSettings Linter, the following benefits are expected to be achieved:
Thank you for your time and consideration. Let's work together to make this project even more robust and reliable!