From 392e1915aeb7411aa2e0bd78800ae126f614c678 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 | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbd4508d3..96b23e209 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,30 @@ 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. Build your changes: + +```sh +make build go-build-local +``` + +2. Build and load the Docker image into Kind: + +```sh +make docker-build +kind load docker-image quay.io/operator-framework/operator-controller:devel +``` + +3. Deploy to Kind + +```sh +make kind-deploy +``` + ### Communication Channels - Email: [operator-framework-olm-dev](mailto:operator-framework-olm-dev@googlegroups.com)