Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (27 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 2.82 KB
Raw

Contributing

Checklist

Before making a contribution to the charts in this repository, you will need to ensure the following steps have been done:

  • Run helm template on the changes you're making to ensure they are correctly rendered into Kubernetes manifests.
  • Lint tests have been run for the Chart using the Chart Testing tool and the ct lint command.
  • For each Chart updated, version bumped in the corresponding Chart.yaml according to Semantic Versioning.
  • For each Chart updated, ensure variables are documented in the corresponding values.yaml file and the pre-commit hook has been run with pre-commit run --all-files to generate the corresponding README.md documentation. The pre-commit Workflow will enforce this and warn you if needed.
  • JSON Schema template updated and re-generated the raw schema via the pre-commit hook.
  • If you updated the orchestrator-infra chart, make sure the versions of the Knative CRDs are aligned with the versions of the CRDs installed by the OpenShift Serverless operators declared in the values.yaml file. See Installing Knative Eventing and Knative Serving CRDs for more details.

Sync Lightspeed Core vendored config files

The Lightspeed Core config files under charts/rhdh/files/intelligent-assistant are synced from the upstream redhat-developer/rhdh-intelligent-assistant-configs repository by hack/sync-lightspeed-configs.sh.

Use the default upstream branch:

./hack/sync-lightspeed-configs.sh

Sync from a release branch or a tag:

./hack/sync-lightspeed-configs.sh --ref release-1.9
./hack/sync-lightspeed-configs.sh --ref v0.5.0

Verify the vendored files are already in sync without writing changes:

./hack/sync-lightspeed-configs.sh --ref main --check

The script copies the upstream lightspeed-stack.yaml and rhdh-profile.py files into charts/rhdh/files/intelligent-assistant. The RHDH chart does not vendor a Lightspeed Core secret.yaml; supply provider credentials with intelligentAssistant.existingSecret.

After syncing, preserve the chart-specific commented rag block and its OKP integration TODO in lightspeed-stack.yaml. This temporary downstream patch means --check reports a difference for that file. Choose the upstream branch or tag that matches the Lightspeed Core release you want to vendor.