From f6e71475821e5341e5306f4cd48cf2b46507aee5 Mon Sep 17 00:00:00 2001 From: Docs Date: Tue, 19 Apr 2022 11:56:57 -0700 Subject: [PATCH] Add note about yq --- docs/contributing-devguide.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/contributing-devguide.md b/docs/contributing-devguide.md index a029c359e..cfcca21f2 100644 --- a/docs/contributing-devguide.md +++ b/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` \ No newline at end of file +When finished writing/reviewing the docs, clean up your local docs branch changes with `git branch -D gh-pages`