Skip to content

Commit

Permalink
Add note on other action
Browse files Browse the repository at this point in the history
  • Loading branch information
bmuschko committed Nov 9, 2023
1 parent 5a16947 commit 13d0ecf
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

A GitHub Action that sets up the commandline-based Kubernetes manifest validation tool [Kubeconform](https://github.com/yannh/kubeconform). The tool will be downloaded from the [Kubeconform releases page](https://github.com/yannh/kubeconform/releases), installed, and added to the `PATH` environment variable automatically. All operating systems and architectures are supported for released artifacts.

> **_NOTE:_** Instead of using this action, you may want to run [Kubeconform in a container](https://github.com/yannh/kubeconform#integrating-kubeconform-in-the-ci). Refer to the documentation for more information.
## Using the Action

It's recommended to use the action as a single setup step. Subsequent steps can directly call the executable. There are no limitation to the options that can be provided to the `kubeconform` command. The following example shows its usage.
Expand Down

0 comments on commit 13d0ecf

Please sign in to comment.