Skip to content

Commit

Permalink
Issue#56 ensure helm docs has been run before commit (#57)
Browse files Browse the repository at this point in the history
* Add pre-commit config

* Add contribution section to README

* Fix path to README
  • Loading branch information
ridoo committed Aug 14, 2023
1 parent f907a8a commit 71c3b75
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
15 changes: 15 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
repos:
- repo: https://github.com/norwoodj/helm-docs
rev: v1.2.0
hooks:
- id: helm-docs
args:
# Make the tool search for charts only under the `example-charts` directory
- --chart-search-root=deployment/geonode

# The `./` makes it relative to the chart-search-root set above
#- --template-files=./_templates.gotmpl

# Repeating the flag adds this to the list, now [./_templates.gotmpl, README.md.gotmpl]
# A base filename makes it relative to each chart directory found
#- --template-files=README.md.gotmpl
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

# Helm Chart for Geonode

Table of Contents
=================
- [GeoWhat?](#Geonode)
- [Geonode-k8s](#geonode-k8s)
- [Install Guilde](#install)
Expand Down Expand Up @@ -82,3 +80,23 @@ helm upgrade --cleanup-on-fail --install --namespace geonode --create-namespac
```bash
helm delete --namespace geonode geonode deployment/geonode
```

## Contribution

### Create an Issue

You found a bug :lady_beetle:?
You have an idea how to improve :bulb:?
Feel free to [create an issue](https://github.com/zalf-rdm/geonode-k8s/issues/new/choose)!


### Documentation

Ensure values.yaml documentation is up-to-date.
The [parameter documentation](deployment/geonode/README.md) is generated via [`helm-docs`](https://github.com/norwoodj/helm-docs).
There is a pre-commit hook configuration so please ensure you install it into your local working copy via

```
pre-commit install
pre-commit install-hooks
```

0 comments on commit 71c3b75

Please sign in to comment.