Support version info in readme

Signed-off-by: Tamal Saha <[email protected]>
kubepack · May 2, 2020 · bf1ee26 · bf1ee26
1 parent 2412995
commit bf1ee26
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 5 deletions.
diff --git a/templates/bindata.go b/templates/bindata.go
@@ -77,7 +77,7 @@ func (fi bindataFileInfo) Sys() interface{} {
 	return nil
 }
 
-var _readmeTpl = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\xcc\x93\xdf\x6f\x22\x37\x10\xc7\xdf\xfd\x57\x8c\x44\x1f\x02\x0a\xcb\x3b\x51\x2b\x45\x49\xab\x46\xa5\x55\x94\x90\x4a\x15\x42\xda\xc9\xee\xc0\xba\xf1\xda\x3e\x7b\x96\x1c\x42\xfc\xef\x27\xdb\xcb\xb2\x70\x89\xee\xee\xe5\xee\xde\xd8\x31\xf3\xeb\xfb\xf9\xce\x00\x76\x3b\xc8\xee\x9d\xf9\x9f\x0a\xce\x1e\x2b\xe3\xf8\x1f\xac\x09\xf6\x7b\x21\x16\xfd\xa7\x36\xba\xbc\xe8\x07\x9f\x1e\x66\xb0\xdf\x0f\x61\x7c\x52\xe5\x96\x7c\xe1\xa4\x65\x69\x74\xac\x33\x18\xc0\x7c\x76\x75\xfb\x70\x25\x44\x9e\xe7\x85\xd1\xde\x28\x12\xbf\x40\x45\xaa\x06\x47\xd6\x00\x96\x65\xac\xf0\x40\xd6\x78\xc9\xc6\x6d\x0f\xfd\xce\xc3\xa9\xe3\x49\x72\x63\x4b\xe4\xae\x9e\xd4\x9e\x51\xa9\x36\x4f\x11\x7a\x7a\xaf\x56\x1b\x9e\x84\xf0\x4d\x85\xae\x5b\x12\xc6\xfa\xb3\x7c\x6f\xb1\x88\xb2\xe4\x79\x1e\x57\xba\xd3\xec\x4c\xd9\x14\x61\x4d\x21\xe6\x95\xf4\x50\x84\x22\x50\x92\x55\x66\xeb\x4f\x24\xb9\xb6\x36\xd4\x35\x1a\x10\x16\x7f\x35\xcf\xe4\x34\x31\xf9\xe5\x45\xc5\x6c\xa7\x93\xc9\x4b\x17\xca\xa4\x19\x42\xa1\x1a\xcf\xe4\xa0\xf1\x52\xaf\x81\x2b\x82\xc5\x9f\xa4\xea\xf4\x77\x3f\x9d\x4c\xc2\xaa\x99\xaf\x86\x60\xb1\x78\xc1\x35\x41\x8d\x1a\xd7\xe4\xb2\x38\xda\xbd\x23\x47\x1f\x1a\xe9\x25\x93\x17\xbb\x1d\x38\xd4\x6b\x0a\xd3\xf4\xe2\x61\x97\xc4\x2d\xfc\xda\xed\xc6\x40\xba\x3c\xf0\xba\x4b\x2a\x1e\xba\x47\x75\x84\x98\x9b\x4e\xde\x10\x4d\xeb\xbe\x4a\xae\xe2\xa7\x4b\x6a\x81\x0e\x22\xe6\x6f\xe8\x9f\x4f\xdf\x32\xc0\xf7\x01\x36\x0f\xf3\x9a\xba\x46\x5d\x7e\x01\x50\x58\xe5\x48\xa8\x43\x21\xd3\x4b\x49\x2b\x6c\x14\x43\x61\xf4\x4a\xae\x1b\x87\x01\x7f\x06\xa1\xfc\xe2\x24\xb6\xbc\x18\x9c\x7c\x0f\xc1\x53\xf4\x0a\x28\xe9\xd9\xc7\x62\x16\x1d\xd6\xc4\xe4\xc2\x27\x32\x14\xa8\xe1\x99\xba\xda\x54\x42\xd9\xb8\xc0\xa0\xd5\x28\x35\x13\xe2\x37\x18\x8d\xe6\xd2\x8e\x46\x53\x98\x49\xcf\x10\xe4\x6b\xd5\xf7\xad\x67\xf2\xa8\x6d\x68\x95\xdc\xfa\xa4\xe5\x7b\x48\x9b\xc3\xd3\xa4\x24\x45\x4c\xf1\xf9\xeb\xf9\xb5\x49\x6f\xe1\xfb\x26\x2a\x8e\x6a\xb3\x21\x0f\x07\x77\xf5\x19\x98\xda\x1a\x4d\x9a\x3d\xa0\xf7\xa6\x90\xc8\x54\x1e\x8d\x97\x7c\x98\xc8\xaa\x98\xd0\xb3\x63\xba\x88\x9b\x3e\x8a\xd4\x77\x65\x94\x32\xaf\x51\x0e\x7c\x56\xd4\xc3\xd2\x71\x0b\xe1\x1e\x23\xb3\x3a\x4a\x73\x62\xbf\xbc\x37\x02\x57\x24\x5d\x67\x93\x0d\xaa\x86\x7c\x26\xc4\x31\xe7\xdf\x18\x8a\x87\xf6\x68\xa9\x90\xab\x2d\x10\x16\xd5\xb1\x51\xef\xea\xf3\xf1\xd8\x13\xc3\x0b\x6d\x7f\x8d\x95\x16\x97\xdd\xcf\x65\x0e\xe8\xd6\x4d\x4d\x9a\x81\x4d\xcb\xbb\x05\x99\x67\xf0\x87\x71\x40\x1f\xb1\xb6\x8a\x7e\xc8\xd5\x41\x9a\xfc\x7c\xed\xdf\xd3\x48\x9d\x01\xae\x15\x93\xd3\xc8\x72\x43\x6a\x7b\x09\x08\xff\x5d\xff\x3d\x83\x95\x54\x94\x2e\xc2\x47\x85\x64\x8b\x34\xa9\x09\x2b\xe3\xce\xcf\xa7\xbd\x1c\xeb\xcc\x46\x96\xc1\x1b\x95\x54\x24\xce\x2c\x1f\x21\xfd\x14\xd2\xb4\x8b\xb4\xee\xd8\x62\xad\xa2\x1c\x9f\x02\x00\x00\xff\xff\xe4\x8b\x19\xab\x8d\x07\x00\x00")
+var _readmeTpl = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\xcc\x94\xdf\x6b\xe3\x38\x10\xc7\xdf\xf5\x57\x0c\xe4\x1e\x9a\xd0\x38\xef\x29\x3d\x28\xed\x1d\x57\x2e\x77\x94\x36\x2d\x2c\x21\xe0\xa9\x3d\x89\xb5\x95\x25\xad\x24\xa7\x1b\x4c\xfe\xf7\x45\x3f\xe2\x38\xd9\x96\xee\xcb\xb2\xfb\x16\x8d\x3c\x33\x9a\xef\xe7\x3b\x19\x40\xdb\x42\x76\x67\xd4\x67\x2a\x5c\xf6\x50\x29\xe3\xfe\xc7\x9a\x60\xb7\x63\x6c\xd1\xbf\x4a\xd1\xe5\x59\x3f\xf8\x78\x3f\x83\xdd\x6e\x08\xe3\xa3\x2a\x37\x64\x0b\xc3\xb5\xe3\x4a\x86\x3a\x83\x01\xcc\x67\x17\x37\xf7\x17\x8c\xe5\x79\x5e\x28\x69\x95\x20\xf6\x07\x54\x24\x6a\x30\xa4\x15\x60\x59\x86\x0a\xf7\xa4\x95\xe5\x4e\x99\xed\xbe\xdf\x69\x38\x76\x3c\x4a\x6e\x74\x89\xae\xab\xc7\xa5\x75\x28\x44\xca\x13\x84\x96\xde\xab\x95\xc2\x13\x1f\xbe\xae\xd0\x74\x43\xc2\x58\x7e\x97\x6f\x35\x16\x41\x96\x3c\xcf\xc3\x48\xb7\xd2\x19\x55\x36\x85\x1f\x93\xb1\x79\xc5\x2d\x14\xbe\x08\x94\xa4\x85\xda\xda\x23\x49\xae\xb4\xf6\x75\x95\x04\x84\xc5\xbf\xcd\x33\x19\x49\x8e\xec\xf2\xac\x72\x4e\x4f\x27\x93\x97\x2e\x94\x71\x35\x84\x42\x34\xd6\x91\x81\xc6\x72\xb9\x06\x57\x11\x2c\xfe\x21\x51\xc7\xcf\xed\x74\x32\xf1\xa3\x66\xb6\x1a\x82\xc6\xe2\x05\xd7\x04\x35\x4a\x5c\x93\xc9\xc2\xd3\xee\x0c\x19\xfa\xd2\x70\xcb\x1d\x59\xd6\xb6\x60\x50\xae\xc9\xbf\xa6\x17\xf7\xb3\x44\x6e\xfe\x57\xdb\x8e\x81\x64\xb9\xe7\x75\x1b\x55\xdc\x77\x0f\xea\x30\x36\x57\x9d\xbc\x3e\x1a\xc7\x7d\xe5\xae\x0a\x47\x13\xd5\x02\xe9\x45\xcc\xdf\xd0\x3f\x9f\xbe\x65\x80\x9f\x0d\xac\x6d\xe3\x13\x53\xc6\x13\x19\x1b\x8d\x09\xe3\xf1\x26\x1e\x2e\xdb\x36\x0b\x1f\x26\x05\x02\xe2\xb9\x9f\x50\xd5\x35\xca\xf2\x03\xa4\x7e\xf8\x03\xd3\x0e\x1e\x8f\x37\x25\xad\xb0\x11\x0e\x0a\x25\x57\x7c\xdd\x18\xf4\x86\xc9\xc0\x97\x5f\x1c\xc5\x96\x67\x83\xa3\xf3\x10\x2c\x05\x77\x81\xe0\xd6\xd9\x50\x4c\xa3\xc1\x9a\x1c\x19\x7f\x44\x07\x05\x4a\x78\xa6\xae\x36\x95\x50\x36\xc6\x53\x4b\xaa\xc6\x66\x8c\xfd\x09\xa3\xd1\x9c\xeb\xd1\x68\x0a\x33\x6e\x1d\x78\xc1\x13\x2f\x9b\x5c\x96\x07\x1a\xbe\x55\xf4\xf7\xa3\xe4\xef\x99\xa0\xd9\x5f\x4d\x4a\x12\xe4\x28\x5c\xff\x38\xf1\x94\xf4\x16\xf0\x0f\x17\xaf\x4f\xc5\x50\xad\x36\x64\x61\xef\xc7\x3e\x03\x55\x6b\x25\x49\x3a\x0b\x68\xad\x2a\x38\x3a\x2a\x0f\x56\x8d\xce\x8d\x64\x45\x48\xe8\x19\x38\xee\xd0\x75\x1f\x45\xec\xbb\x52\x42\xa8\xd7\x20\x07\x3e\x0b\xea\x61\xe9\xb8\xf9\x70\x8f\x91\x5a\x1d\xa4\x39\x32\x6c\xde\x7b\x82\xab\x88\x9b\xce\x26\x1b\x14\x0d\xd9\x8c\xb1\x43\xce\x53\x08\x85\xd5\x7c\xd0\x54\xf0\xd5\x16\x08\x8b\xea\xd0\xa8\xf7\x3f\x91\x8f\xc7\x96\x1c\xbc\xd0\xf6\x32\x54\x5a\x9c\x77\x3f\x97\x39\xa0\x59\x37\x35\x49\x07\x4e\x25\xde\x09\x64\x9e\xc1\xdf\xca\x00\x7d\xc5\x5a\x0b\xfa\x25\x7b\x0a\xf1\xe5\xa7\x63\xff\x15\x9f\xd4\x19\xe0\x4a\x38\x32\x12\x1d\xdf\x90\xd8\x9e\x03\xc2\xa7\xab\xff\x66\xb0\xe2\x82\xe2\x46\xd8\xa0\x10\x4f\x48\xa3\x9a\xb0\x52\xe6\x74\x7d\xd2\xe6\x68\xa3\x36\xbc\xf4\xde\xa8\xb8\x20\x76\x62\xf9\x00\xe9\xb7\x90\x26\x0d\x92\xdc\xb1\xc5\x5a\x04\x39\xbe\x05\x00\x00\xff\xff\x6d\xd0\x87\x05\xbf\x07\x00\x00")
 
 func readmeTplBytes() ([]byte, error) {
 	return bindataRead(
@@ -92,7 +92,7 @@ func readmeTpl() (*asset, error) {
 		return nil, err
 	}
 
-	info := bindataFileInfo{name: "readme.tpl", size: 1933, mode: os.FileMode(420), modTime: time.Unix(1573722179, 0)}
+	info := bindataFileInfo{name: "readme.tpl", size: 1983, mode: os.FileMode(420), modTime: time.Unix(1573722179, 0)}
 	a := &asset{bytes: bytes, info: info}
 	return a, nil
 }

diff --git a/templates/readme.tpl b/templates/readme.tpl
@@ -24,7 +24,7 @@ This chart deploys {{ .Project.App }} on a [Kubernetes](http://kubernetes.io) cl
 To install the chart with the release name `{{ .Release.Name }}`:
 
 ```console
-$ helm install {{ .Release.Name }} {{ .Repository.Name }}/{{ .Chart.Name }} -n {{ .Release.Namespace }}
+$ helm install {{ .Release.Name }} {{ .Repository.Name }}/{{ .Chart.Name }} -n {{ .Release.Namespace }}{{ with .Chart.Version }} --version={{.}}{{ end }}
 ```
 
 The command deploys {{ .Project.App }} on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.

diff --git a/testdata/README.md b/testdata/README.md
@@ -26,7 +26,7 @@ This chart deploys a Stash operator on a [Kubernetes](http://kubernetes.io) clus
 To install the chart with the release name `stash-operator`:
 
 ```console
-$ helm install stash-operator appscode/stash -n kube-system
+$ helm install stash-operator appscode/stash -n kube-system --version=v0.9.0-rc.0
 ```
 
 The command deploys a Stash operator on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
@@ -45,7 +45,7 @@ The command removes all the Kubernetes components associated with the chart and
 
 ## Configuration
 
-The following table lists the configurable parameters of the Stash chart and their default values.
+The following table lists the configurable parameters of the `stash` chart and their default values.
 
 |               Parameter               |                                                                                                                    Description                                                                                                                    |                                Default                                |
 |---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|

diff --git a/testdata/doc.json b/testdata/doc.json
@@ -12,6 +12,7 @@
   },
   "chart": {
     "name": "stash",
+    "version": "v0.9.0-rc.0",
     "values": "-- generate from values file --",
     "valuesExample": "-- generate from values file --"
   },

diff --git a/testdata/doc.yaml b/testdata/doc.yaml
@@ -9,6 +9,7 @@ repository:
   name: appscode
 chart:
   name: stash
+  version: v0.9.0-rc.0
   values: "-- generate from values file --"
   valuesExample: "-- generate from values file --"
 prerequisites:

diff --git a/types.go b/types.go
@@ -39,6 +39,7 @@ type RepositoryInfo struct {
 
 type ChartInfo struct {
 	Name          string `json:"name"`
+	Version       string `json:"version"`
 	Values        string `json:"values"`
 	ValuesExample string `json:"valuesExample"`
 }