Remove unused property desc

jlandowner · Dec 20, 2023 · 9244250 · 9244250
1 parent 45c68f3
commit 9244250
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -180,8 +180,6 @@ Values files can have a `testSpec` property that can detail or control the test
 
 ```yaml
 testSpec:
- # desc is a description for the set of values
- desc: only required values and the rest is default
  # dynamicFields defines values that are dynamically generated by Helm function like 'randAlphaNum'
  # https://helm.sh/docs/chart_template_guide/function_list/#randalphanum-randalpha-randnumeric-and-randascii
  # Replace outputs with fixed values to prevent unmatched outputs at each snapshot.
@@ -199,6 +197,26 @@ testSpec:
 # ...
 ```
 
+Or if you have multiple test values file, you can place `.chartsnap.yaml` in your test values directory to configure common behavior of your chart snapshots.
+
+```yaml:.chartsnap.yaml
+testSpec:
+ dynamicFields:
+ - apiVersion: v1
+ kind: Secret
+ name: cosmo-auth-env
+ jsonPath:
+ - /data/COOKIE_HASHKEY
+ - /data/COOKIE_BLOCKKEY
+ - /data/COOKIE_HASHKEY
+ - /data/COOKIE_SESSION_NAME
+```
+
+```sh
+$ ls -l test/
+
+```
+
 ## Showcase & Users ✨
 
 | Users / Projects | Description | URL |

diff --git a/main.go b/main.go
@@ -85,8 +85,6 @@ In addition, Values files can have a ` + "`" + `testSpec` + "`" + ` property tha
 
 ` + "```" + `yaml
 testSpec:
- # desc is a description for the set of values
- desc: only required values and the rest is default
  # dynamicFields defines values that are dynamically generated by Helm function like 'randAlphaNum'
  # https://helm.sh/docs/chart_template_guide/function_list/#randalphanum-randalpha-randnumeric-and-randascii
  # Replace outputs with fixed values to prevent unmatched outputs at each snapshot.

diff --git a/pkg/charts/testspec.go b/pkg/charts/testspec.go
@@ -13,7 +13,6 @@ type SnapshotValues struct {
 }
 
 type TestSpec struct {
- Description string `yaml:"desc,omitempty"`
  DynamicFields []ManifestPath `yaml:"dynamicFields,omitempty"`
 }