Skip to content

Commit 9899525

Browse files
committed
Update README.md
1 parent 51582a4 commit 9899525

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,6 @@
22

33
This repository contains JOSA's custom pre-commit hooks.
44

5-
___
6-
7-
## Using pre-commit-hooks with pre-commit
8-
9-
Add this to your .pre-commit-config.yaml:
10-
11-
```yaml
12-
- repo: https://github.com/jordanopensource/pre-commit-hooks
13-
rev: v0.1.0 # Use the ref you want to point at
14-
hooks:
15-
- id: validate-flux
16-
# - id: ...
17-
```
18-
195
## Available Hooks
206

217
- [Validate Flux](#validate-flux) - A script to validate Flux custom resources and Kustomize overlays.
@@ -36,8 +22,22 @@ You need the following to be installed on your machine before running this pre-c
3622
- [kustomize v4.1](https://github.com/kubernetes-sigs/kustomize)
3723
- [kubeconform v0.4.12](https://github.com/yannh/kubeconform)
3824

39-
Also make sure to have the git hook script pre-push installed
25+
### Usage
26+
27+
Add this to your .pre-commit-config.yaml:
28+
29+
```yaml
30+
- repo: https://github.com/jordanopensource/pre-commit-hooks
31+
rev: v0.1.0 # Use the ref you want to point at
32+
hooks:
33+
- id: validate-flux
34+
# - id: ...
35+
```
36+
37+
After the configuration is added, you'll need to run
4038

4139
```bash
4240
pre-commit install -t pre-push
4341
```
42+
43+
___

0 commit comments

Comments
 (0)