Browse Source

Add note about yq

Docs 4 years ago
parent
commit
f6e7147582
1 changed files with 3 additions and 1 deletions
  1. 3 1
      docs/contributing-devguide.md

+ 3 - 1
docs/contributing-devguide.md

@@ -8,6 +8,8 @@ git clone https://github.com/external-secrets/external-secrets.git
 cd external-secrets
 ```
 
+_Note: many of the `make` commands use [yq](https://github.com/mikefarah/yq), version 4.2X.X or higher._
+
 If you want to run controller tests you also need to install kubebuilder's `envtest`.
 
 The recommended way to do so is to install [setup-envtest](https://pkg.go.dev/sigs.k8s.io/controller-runtime/tools/setup-envtest)
@@ -124,4 +126,4 @@ Open `http://localhost:8000` in your browser.
 
 Since mike uses a branch to create/update documentation, any docs operation will create a diff on your local `gh-pages` branch.
 
-When finished writing/reviewing the docs, clean up your local docs branch changes with `git branch -D gh-pages`
+When finished writing/reviewing the docs, clean up your local docs branch changes with `git branch -D gh-pages`