CONTRIBUTING.md

Contributing Guide

Reporting issues

To report issues against this repository, please use JIRA: https://issues.redhat.com/browse/RHIDP with Component: Support.

To browse the existing issues, you can use this Query.

Contributions are welcome!

Local Development/Testing

Testing

# View all available targets
make help

# Run locally (requires Go, kubectl/oc, and access to a cluster)
make run-local

# Test with OpenShift using oc adm must-gather
make deploy-openshift

# Test on regular Kubernetes (non-OpenShift) by creating a Job in the cluster
make deploy-k8s

# Clean up test artifacts and images
make clean

Building the Image

# Build locally
make image-build

# Build and push to registry
make image-push REGISTRY=your-registry.com IMAGE_NAME=namespace/rhdh-must-gather

# Build and push with custom image name and tag
make image-push REGISTRY=your-registry.com IMAGE_NAME=namespace/my-rhdh-must-gather IMAGE_TAG=v1.0.0

Hermetic build (Konflux parity)

Downstream Konflux builds use .rhdh/docker/Containerfile with prefetched RPM and Go modules (no network during podman build). CI runs the same path via Hermeto.

# Full hermetic build (fetch deps + build with --network none; version matches make image-build)
make hermetic-build REGISTRY=localhost IMAGE_NAME=rhdh-must-gather IMAGE_TAG=hermetic-test
# Optional: make hermetic-build VERSION=2.1.0-custom

# Or use the script directly
./scripts/local-hermeto-build.sh -d . -i localhost/rhdh-must-gather:hermetic-test
podman run --rm localhost/rhdh-must-gather:hermetic-test --help

The root Containerfile remains for quick local iteration (make image-build); production and PR CI use the hermetic Containerfile.