mirrors/kyverno
mirrors/kyverno
1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2025-03-05 07:26:55 +00:00
Code Activity

docs: add section for dev tools (#4443)

Browse source 
Signed-off-by: Charles-Edouard Brétéché <charled.breteche@gmail.com>
This commit is contained in:
Charles-Edouard Brétéché 2022-08-29 18:32:56 +02:00 • committed by GitHub
parent 504acea12c
commit c900c6832b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
DEVELOPMENT.md
View file

@ -1,5 +1,33 @@
# Developer Instructions
This document covers basic needs to work with Kyverno codebase.
It contains instructions to build, run, and test Kyverno.
- [Tools](#tools)
- [Building and publishing an image locally](#building-and-publishing-an-image-locally)
## Tools
Building and/or testing Kyverno requires additional tooling.
We use `make` to simplify installing the tools we use.
Tools will be installed in the `.tools` folder when possible, this allows keeping installed tools local to the Kyverno repository.
The `.tools` folder is ignored by `git` and binaries should not be committed.
You can install tools by running:
```
make install-tools
```
To remove installed tools, run:
```
make clean-tools
```
> **Note**: If you don't install tools, they will be downloaded/installed as necessary when running `make` targets.
## Building and publishing an image locally
First, make sure you [install `ko`](https://github.com/google/ko#install)