Merge pull request #462 from umohnani8/docs

: no-jira: Update Makefile and Add Testing Info

Author: openshift-merge-bot[bot]

Makefile

@@ -9,6 +9,20 @@ include $(addprefix ./vendor/github.com/openshift/build-machinery-go/make/, \
 
 IMAGE_REGISTRY :=registry.ci.openshift.org
 
+# Check which builder to use - default is imagebuilder
+ifeq ($(BUILDER), podman)
+# Use podman to build the must gather image
+# Please ensure you have podman installed on your machine for this
+IMAGE_BUILD_BUILDER := podman build
+# Clear all build default flags
+IMAGE_BUILD_DEFAULT_FLAGS :=
+# Set authfile if the user passes another location for the authentication file
+ifneq ($(strip $(AUTH_FILE)),)
+IMAGE_BUILD_DEFAULT_FLAGS := --authfile=$(AUTH_FILE)
+endif
+endif
+
+
 # This will call a macro called "build-image" which will generate image specific targets based on the parameters:
 # $0 - macro name
 # $1 - target name

README.md

@@ -15,5 +15,23 @@ included.
 You can run `must-gather` on a cluster with `oc adm must-gather`. 
 Use `-h` flag to see available options.
 
+## How to test
+Build a new must-gather image with your changes using the Makefile. There are two options in the Makefile, `make` will use imagebuilder to build the image while `make BUILDER=podman` will use podman to build the image.
+
+If using `make BUILDER=podman`, please set the `AUTH_FILE` parameter pointing to an authentication file that has credentials for the `registry.ci.openshift.org` registry. Ensure that you are connected to the VPN before building the image.
+```
+make BUILDER=podman AUTH_FILE=/path/to/authfile
+```
+
+Once the image is built, push it to a registry where it can be accessed from. 
+```
+podman push [built-image] [registry/username/your-built-image]
+``` 
+
+To test your new changes with a cluster, run the following:
+```
+oc adm must-gather --image=registry/username/your-built-image
+```
+
 ## Obfuscate confidential information
 There is a dedicated effort to obfuscate and omit confidential information. Head over to [openshift/must-gather-clean](https://github.com/openshift/must-gather-clean) for more information.

go.mod

@@ -1,5 +1,7 @@
 module github.com/openshift/must-gather
 
-go 1.22
+go 1.22.0
 
-require github.com/openshift/build-machinery-go v0.0.0-20210423112049-9415d7ebd33e
+toolchain go1.22.7
+
+require github.com/openshift/build-machinery-go v0.0.0-20250102153059-e85a1a7ecb5c

go.sum

@@ -1,2 +1,2 @@
-github.com/openshift/build-machinery-go v0.0.0-20210423112049-9415d7ebd33e h1:F7rBobgSjtYL3/zsgDUjlTVx3Z06hdgpoldpDcn7jzc=
-github.com/openshift/build-machinery-go v0.0.0-20210423112049-9415d7ebd33e/go.mod h1:b1BuldmJlbA/xYtdZvKi+7j5YGB44qJUJDZ9zwiNCfE=
+github.com/openshift/build-machinery-go v0.0.0-20250102153059-e85a1a7ecb5c h1:6XcszPFZpan4qll5XbdLll7n1So3IsPn28aw2j1obMo=
+github.com/openshift/build-machinery-go v0.0.0-20250102153059-e85a1a7ecb5c/go.mod h1:8jcm8UPtg2mCAsxfqKil1xrmRMI3a+XU2TZ9fF8A7TE=