helm/chart-testing
1
0
Fork 0
mirror of https://github.com/helm/chart-testing.git synced 2026-02-05 18:45:18 +01:00
Code Issues Activity

Update readme (#44)

Browse Source 
* Update readme

* fix urls so that they are absolute
* add link to docker tags
* minor formatting

Signed-off-by: Michał Sochoń <kaszpir@gmail.com>

* ensure that titles follow standards in README.md

Signed-off-by: Michał Sochoń <kaszpir@gmail.com>

* Spell check across README.md

Signed-off-by: Michał Sochoń <kaszpir@gmail.com>

* Ensure docs describe order of loading of config files

Signed-off-by: Michał Sochoń <kaszpir@gmail.com>

* Remove colon from title in README.md

Signed-off-by: Michał Sochoń <kaszpir@gmail.com>
This commit is contained in:
Michał Sochoń
2018-11-09 06:30:01 -08:00
committed by Scott Rigby
parent f632cd5081
commit 09a6f114ae
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -8,7 +8,7 @@ It automatically detects charts changed against the target branch.
### Prerequisites
It is recommended to use the provided Docker image which can be [found on Quay](quay.io/helmpack/chart-testing/).
It is recommended to use the provided Docker image which can be [found on Quay](https://quay.io/helmpack/chart-testing/).
It comes with all necessary tools installed.
* Helm (http://helm.sh)
@@ -27,7 +27,8 @@ Unpack the `ct` binary, add it to your PATH, and you are good to go!
### Docker Image
A Docker image is available at `quay.io/helmpack/chart-testing`.
A Docker image is available at `quay.io/helmpack/chart-testing` with list of
available tags [here](https://quay.io/repository/helmpack/chart-testing?tab=tags).
## Usage
@@ -84,10 +85,16 @@ chart-dirs:
build-id: pr-42
```
`ct install --config config.yaml`
#### Config Usage
ct install --config config.yaml
`ct` supports any format [Viper](https://github.com/spf13/viper) can read, i. e. JSON, TOML, YAML, HCL, and Java properties files.
Notice that if no config file is specified, then `ct.yaml` (or any of the supported formats) is loaded from the current directory, `$HOME/.ct`, or `/etc/ct`, in that order, if found.
## Building from Source
`ct` is built using Go 1.11. Older versions may work but have not been tested.