Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (43 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 1.58 KB

Contributing

Local Development

Prerequisites

  • Helm 3.x
  • A local Kubernetes cluster (e.g., minikube). The default resource requests require at least 12GB of memory. For minikube, configure this before creating your cluster: 
    minikube config set memory 12288  # 12GB

Building Dependencies

Fetch the subchart dependencies (PostgreSQL, Valkey). You only need to re-run this when the dependencies in Chart.yaml are updated:

helm dependency build ./charts/sourcebot

Deploying Locally

Apply the secrets and deploy the minimal installation example:

kubectl apply -f examples/minimal-installation/secrets.yaml
helm upgrade --install sourcebot ./charts/sourcebot \
  -f examples/minimal-installation/values.yaml \
  --set-json "sourcebot.config=$(cat examples/minimal-installation/config.json)"

Port forward to access Sourcebot at http://localhost:3000:

kubectl port-forward svc/sourcebot 3000:3000

Validating Changes

Lint the chart:

helm lint ./charts/sourcebot -f ./charts/sourcebot/values.lint.yaml

Render templates locally without deploying:

helm template sourcebot ./charts/sourcebot -f ./charts/sourcebot/values.lint.yaml

Run the chart tests:

helm test sourcebot

Updating Docs

The chart README is auto-generated from values.yaml comments using helm-docs. After modifying values.yaml, regenerate the docs:

helm-docs --chart-search-root ./charts