From e950fb5e5d690564d644723d815aaa91126aea80 Mon Sep 17 00:00:00 2001 From: Camila Macedo Date: Wed, 6 Nov 2024 20:14:45 +0000 Subject: [PATCH] docs: add local build and deploy instructions to CONTRIBUTING.md - Added steps for building, loading Docker images, and deploying changes locally with Kind --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbd4508d3..2ca434ce1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,29 @@ The workflow defined above implies that the community is always ready for discus Please keep this workflow in mind as you read through the document. +## How to Build and Deploy Locally + +After creating a fork and cloning the project locally, +you can follow the steps below to test your changes: + +1. Create the cluster: + +```sh +kind create cluster operator-controller +``` + +2. Build your changes: + +```sh +make build docker-build +``` + +3. Load the image locally and Deploy to Kind + +```sh +make kind-load kind-deploy +``` + ### Communication Channels - Email: [operator-framework-olm-dev](mailto:operator-framework-olm-dev@googlegroups.com)