diff --git a/CHANGELOG.md b/CHANGELOG.md index b0c6526..643f365 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Change Log +## 0.9.0 + +### Features + +* Introduced `Fix...` quick action. It allows to automatically fix most of misconfigurations. +* Introduced `Suppress...` quick action. It allows to suppress each rule within a single resource. +* Introduced `Show details...` quick action. It allows to navigate quickly to current misconfiguration in Violations panel. +* Introduced `monokle.automaticallyOpenPanel` configuration option. It allows to define when Violations panel should be shown automatically. + ## 0.8.3 ### Fixes diff --git a/README.md b/README.md index 55cb64d..f7edccb 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,23 @@ This is **Technical Preview** release. We are open to any feedback and eager to ## Features +### Validate your resources in a blink of an eye + +Monokle extension runs in a background and validates all resources within your workspace in real-time. After installing the extension, default policy is used so you are ready to go! + +Policy can be changed using [`Monokle: Bootstrap configuration` command](#adjust-to-your-needs) or by [connecting to Monokle Cloud](#monokle-cloudenterprise-integration-setup) to use centralized policy. + +### Fix your resources with ease + +You can fix most of the problems with Autofix quick action! Just open a quick fix panel and apply "Fix..." action. + +

+ +

+ ### Easily navigate through all errors and resources -Monokle validation panel allows you to easily see all validation errors grouped by resource or rule id, see each rule details and navigate to exact line in each resource where violation was detected. +Monokle validation panel allows you to easily see all validation errors grouped by resource or rule id, see rule details and navigate to exact line in each resource where violation was detected.

@@ -48,6 +62,14 @@ Validation runs in a background every time a file is modified and saved. This wa

+### Suppress specific rules for any resource + +You can suppress rules for specific resources via "Suppress..." quick fix action. This instructs Monokle extension that the resource is the way you wanted and ignore the rule for this specific resource. + +

+ +

+ ### Adjust to your needs With dedicated `Monokle: Bootstrap configuration` command, you can customize validation configuration in seconds and adjust to your specific needs. @@ -139,14 +161,16 @@ After the setup is done, you can run `Monokle: Synchronize` command to speed-up This extension contributes the following settings: -* `monokle.enable` - Enable/disable this extension. -* `monokle.configurationPath` - Set path to validation configuration file. -* `monokle.verbose` - Log runtime info to VSC Developer Console. +* `monokle.run` - Run resource validation when typing (`onType`) or only when file is saved (`onSave`). +* `monokle.automaticallyOpenPanel` - Open **Violations** panel automatically when project is opened (`onProjectOpen`) or never (`never`). +* `monokle.configurationPath` - Set path to external validation configuration file. +* `monokle.project` - Define remote project from which policy should be used for validation. * `monokle.origin` - Overwrite default Monokle Cloud URL (e.g. when running own Monokle Enterprise instance). +* `monokle.enabled` - Enable/disable this extension. * `monokle.telemetryEnabled` - Enable/disable anonymous telemetry. -* `monokle.project` - Define remote project from which policy should be used for validation. +* `monokle.verbose` - Log runtime information to VSC Developer Console. -> **IMPORTANT**: Project id used for `monokle.project` can be obtain on Project details page from current URL `https://app.monokle.com/dashboard/projects/`. +> **IMPORTANT**: Project slug used for `monokle.project` can be found in `Project` > `Settings` tab in a `Project slug` field. ## Dependencies diff --git a/assets/gifs/autofixes.gif b/assets/gifs/autofixes.gif new file mode 100644 index 0000000..0638b95 Binary files /dev/null and b/assets/gifs/autofixes.gif differ diff --git a/assets/gifs/configuration.gif b/assets/gifs/configuration.gif index 34134f9..0c8f8e2 100644 Binary files a/assets/gifs/configuration.gif and b/assets/gifs/configuration.gif differ diff --git a/assets/gifs/navigation.gif b/assets/gifs/navigation.gif index 4f47cec..a090148 100644 Binary files a/assets/gifs/navigation.gif and b/assets/gifs/navigation.gif differ diff --git a/assets/gifs/problems.gif b/assets/gifs/problems.gif index 0e2f0ed..e1ce46d 100644 Binary files a/assets/gifs/problems.gif and b/assets/gifs/problems.gif differ diff --git a/assets/gifs/realtime-validation.gif b/assets/gifs/realtime-validation.gif index 1ebcbcb..4317a46 100644 Binary files a/assets/gifs/realtime-validation.gif and b/assets/gifs/realtime-validation.gif differ diff --git a/assets/gifs/remote-policy-config.gif b/assets/gifs/remote-policy-config.gif index b928ef2..0335d6f 100644 Binary files a/assets/gifs/remote-policy-config.gif and b/assets/gifs/remote-policy-config.gif differ diff --git a/assets/gifs/remote-policy-sync.gif b/assets/gifs/remote-policy-sync.gif index a52efeb..c3ed5df 100644 Binary files a/assets/gifs/remote-policy-sync.gif and b/assets/gifs/remote-policy-sync.gif differ diff --git a/assets/gifs/suppress.gif b/assets/gifs/suppress.gif new file mode 100644 index 0000000..0a63345 Binary files /dev/null and b/assets/gifs/suppress.gif differ diff --git a/assets/images/policies.png b/assets/images/policies.png index 4c6fe7b..ab7963e 100644 Binary files a/assets/images/policies.png and b/assets/images/policies.png differ diff --git a/assets/images/projects.png b/assets/images/projects.png index b4a3299..59caa57 100644 Binary files a/assets/images/projects.png and b/assets/images/projects.png differ diff --git a/assets/images/repos.png b/assets/images/repos.png index 205a657..3de3ca9 100644 Binary files a/assets/images/repos.png and b/assets/images/repos.png differ