Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Commit

Permalink
Add helm-docs reference updates for chart's README (#1836)
Browse files Browse the repository at this point in the history
  • Loading branch information
eduser25 authored Oct 14, 2020
1 parent b91c46b commit 893cf96
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/release_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,17 @@ and build and push Docker images for OSM and the demo to the
In the description section of the new release, add information about feature additions, bug fixes,
and any other administrative tasks completed on the repository.

## Update README chart with helm-docs

Chart's README is autogenerated with [helm-docs](https://github.com/norwoodj/helm-docs). Once versioning has been addressed
under `charts/osm/Chart.yaml`, you can, for example, update the README using `helm-docs` as follows:

```
go get github.com/norwoodj/helm-docs/cmd/helm-docs # This will add helm-docs on modules if you have GO111MODULE enabled
cd charts/osm
helm-docs # Assuming $GOBIN is available on $PATH
```

## Create a Helm chart release

* create a Git tag from main in the format `chart/x.x.x` where `x.x.x` is the chart version
Expand Down

0 comments on commit 893cf96

Please sign in to comment.