Skip to content

Latest commit

 

History

History
82 lines (62 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

82 lines (62 loc) · 1.86 KB

CONTRIBUTING

Build and generate template yml locally

helm package ./charts/cadence
helm template cadence-release cadence-0.1.5.tgz > template_out.yaml

Build and deploy to a k8s cluster

  1. Build helm package and deploy to a k8s cluster
helm package ./charts/cadence
helm upgrade --install cadence-release cadence-0.1.5.tgz \
    -n cadencetest \
    --create-namespace
  1. Port forward to check the UI
kubectl port-forward svc/cadence-web-service 8088:8088 -n cadencetest

Visit localhost:8088 and validate it is accessible.

  1. Port forward frontend service to run CLI commands
kubectl port-forward svc/cadence-frontend 7833:7833 -n cadencetest
  1. Register a domain:
cadence --env development \
    --address localhost:7833 \
    --transport grpc \
    --domain samples-domain \
    domain register \
    --retention 1
  1. Run samples:
host: "localhost:7833"
  • Run sample worker (run at samples repo root)
./bin/helloworld -m worker
  • Trigger a workflow (run at samples repo root)
./bin/helloworld -m trigger
  1. Visit localhost:8088 and validate the new workflow exists!

Generate helmdocs

Install helm-docs:

go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest

Run it

helm-docs

cadencechart/README.md file should be updated.

Publish chart

After making changes to templates, increment the chart version in charts/cadence/Chart.yaml. Then merge your changes and automation will take care of publishing the new version. Cadence chart is hosted on github pages and automation is done using Chart Releaser Action. After new version is available in helm repo, deploy it to a K8s cluster to validate.