Skip to content

Commit

Permalink
Change the docs to indicate that make lint is the preferred method to…
Browse files Browse the repository at this point in the history
… lint locally
  • Loading branch information
iblutrifork committed Mar 5, 2024
1 parent a010cba commit a044206
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,17 @@ cd charts/flink-job
helm lint . --values ci/example-values.yaml
```

To lint the charts on the cluster, you can use the `lintchart.sh` script in the root of this repository.
e.g.:
```bash
./lintchart.sh flink-job 20
```

To run linting on your local machine, use `make lint` at the root of this repository.
This will make use of [`ct`](https://github.com/helm/chart-testing) - a CLI for linting and testing on a running Kubernetes cluster.

Alternatively, if you require more fine-grained local linting, you can check the script `lintchart.sh`
It is setup to lint the charts on the cluster but can be edited to suit local development.
Example usage (identical to `make lint` but for 1 directory only):
```bash
./lintchart.sh flink-job 20
```

### Docs

To update documentation from your local machine, use `make docs` at the root of this repository.
Expand Down

0 comments on commit a044206

Please sign in to comment.