Skip to content

Commit

Permalink
Add vet command to docs
Browse files Browse the repository at this point in the history
Signed-off-by: Stefan Prodan <[email protected]>
  • Loading branch information
stefanprodan committed Oct 20, 2023
1 parent 89acc34 commit aede702
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Module examples can be found at [examples/minimal](examples/minimal) and [exampl
Commands for working with local modules:

- `timoni mod init <module-name>`
- `timoni mod lint <path/to/module>`
- `timoni mod vet <path/to/module>`
- `timoni build <name> <path/to/module> -n <namespace>`
- `timoni apply <name> <path/to/module> -f <path/to/values.cue> --dry-run --diff`

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Module structure:
Commands for working with local modules:

- `timoni mod init <module-name>`
- `timoni mod lint <path/to/module>`
- `timoni mod vet <path/to/module>`
- `timoni build <name> <path/to/module> -n <namespace>`
- `timoni apply <name> <path/to/module> -f <path/to/values.cue> --dry-run --diff`

Expand Down
6 changes: 3 additions & 3 deletions docs/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,11 @@ To enforce a minimum supported version for your module, set a constraint for the
version e.g. `kubeMinorVersion: int & >=20`.

To test the constraint, you can use the `TIMONI_KUBE_VERSION` env var
with `timoni mod lint` and `timoni build`.
with `timoni mod vet` and `timoni build`.

```console
$ TIMONI_KUBE_VERSION=1.19.0 timoni mod lint ./myapp
build failed: timoni.kubeMinorVersion: invalid value 19 (out of bound >=20)
$ TIMONI_KUBE_VERSION=1.19.0 timoni mod vet ./myapp
validation failed: timoni.kubeMinorVersion: invalid value 19 (out of bound >=20)
```

## Ignore
Expand Down

0 comments on commit aede702

Please sign in to comment.