Skip to content

Commit fadedcc

Browse files
1gtmtamalsaha
andauthored
[cherry-pick] Generate README.md using templates (#512) (#513)
/cherry-pick Signed-off-by: Tamal Saha <tamal@appscode.com> Co-authored-by: Tamal Saha <tamal@appscode.com>
1 parent 46e2b6d commit fadedcc

File tree

3 files changed

+48
-2
lines changed

3 files changed

+48
-2
lines changed

Makefile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,11 @@ gen-values-schema: $(BUILD_DIRS)
266266
rm -rf bin/values.openapiv3_schema.yaml; \
267267
done
268268

269+
.PHONY: gen-readme
270+
gen-readme:
271+
jq -n -c --arg v "$(CHART_VERSION)" '{"version":$$v}' > /tmp/data.json
272+
render-gotpl --template=hack/templates/readme.txt --data=/tmp/data.json > README.md
273+
269274
.PHONY: gen-chart-doc
270275
gen-chart-doc: gen-chart-doc-stash-postgres
271276

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Install PostgreSQL 10.6 backup or restore plugin for Stash as below.
1515
```console
1616
helm repo add appscode https://charts.appscode.com/stable/
1717
helm repo update
18-
helm install appscode/stash-postgres --name=stash-postgres-10.6 --version=10.6
18+
helm install stash-postgres-11.2-v2 appscode/stash-postgres --version=11.2-v2
1919
```
2020

2121
To install catalog for all supported PostgreSQL versions, please visit [here](https://github.com/stashed/catalog).
@@ -25,7 +25,7 @@ To install catalog for all supported PostgreSQL versions, please visit [here](ht
2525
Uninstall PostgreSQL 10.6 backup or restore plugin for Stash as below.
2626

2727
```console
28-
helm delete stash-postgres-10.6
28+
helm delete stash-postgres-11.2-v2
2929
```
3030

3131
## Support

hack/templates/readme.txt

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
[![Go Report Card](https://goreportcard.com/badge/stash.appscode.dev/postgres)](https://goreportcard.com/report/stash.appscode.dev/postgres)
2+
![CI](https://github.com/stashed/postgres/workflows/CI/badge.svg)
3+
[![Docker Pulls](https://img.shields.io/docker/pulls/stashed/stash-postgres.svg)](https://hub.docker.com/r/stashed/stash-postgres/)
4+
[![Slack](https://slack.appscode.com/badge.svg)](https://slack.appscode.com)
5+
[![Twitter](https://img.shields.io/twitter/follow/kubestash.svg?style=social&logo=twitter&label=Follow)](https://twitter.com/intent/follow?screen_name=KubeStash)
6+
7+
{{ $v := semver .version -}}
8+
9+
# Postgres
10+
11+
Postgres backup and restore plugin for [Stash by AppsCode](https://stash.run).
12+
13+
## Install
14+
15+
Install PostgreSQL {{ $v.Major }}.{{ $v.Minor }} backup or restore plugin for Stash as below.
16+
17+
```console
18+
helm repo add appscode https://charts.appscode.com/stable/
19+
helm repo update
20+
helm install stash-postgres-{{ .version }} appscode/stash-postgres --version={{ .version }}
21+
```
22+
23+
To install catalog for all supported PostgreSQL versions, please visit [here](https://github.com/stashed/catalog).
24+
25+
## Uninstall
26+
27+
Uninstall PostgreSQL {{ $v.Major }}.{{ $v.Minor }} backup or restore plugin for Stash as below.
28+
29+
```console
30+
helm delete stash-postgres-{{ .version }}
31+
```
32+
33+
## Support
34+
35+
To speak with us, please leave a message on [our website](https://appscode.com/contact/).
36+
37+
To join public discussions with the Stash community, join us in the [AppsCode Slack team](https://appscode.slack.com/messages/C8NCX6N23/details/) channel `#stash`. To sign up, use our [Slack inviter](https://slack.appscode.com/).
38+
39+
To receive product annoucements, follow us on [Twitter](https://twitter.com/KubeStash).
40+
41+
If you have found a bug with Stash or want to request new features, please [file an issue](https://github.com/stashed/project/issues/new).

0 commit comments

Comments
 (0)