diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index eb14440e..f3d086a0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,5 @@ +Checklist: + * [ ] I have update the chart version in `Chart.yaml` following Semantic Versioning. -* [ ] All new values are backwards compatible and/or have sensible default. -* [ ] I have installed the chart myself and it works. - -E.g. for Argo Workflows: - -``` -helm install charts/argo -argo version -``` - -E.g. for Argo CD: - -``` -helm install charts/argo-cd --namespace argocd -kubectl port-forward svc/argocd-server -n argocd 8080:443 & -argocd version -``` +* [ ] Any new values are backwards compatible and/or have sensible default. +* [ ] I have followed the testing instructions in the [contributing guide](https://github.com/argoproj/argo-helm/blob/master/CONTRIBUTING.md). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0e483c31..e6370aeb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,53 @@ # Contributing -Argo Helm is a collection of **community maintained** charts. Therefore we rely on you to test your changes correctly +Argo Helm is a collection of **community maintained** charts. Therefore we rely on you to test your changes sufficiently. +## Testing Argo Workflows Changes + +Minimally: + +``` +helm install charts/argo -n argo +argo version +``` + +Follow this instructions for running a hello world workflow. + +## Testing Argo CD Changes + +Clean-up: + +``` +helm delete argo-cd --purge +kubectl delete crd -l app.kubernetes.io/part-of=argo-cd +``` + +Minimally: + +``` +helm install charts/argo-cd --namespace argocd -n argo-cd +kubectl port-forward svc/argocd-server -n argocd 8080:443 +``` + +In a new terminal: + +``` +argocd version +# reset password to 'Password1!' +kubectl -n argocd patch secret argocd-secret \ + -p '{"stringData": { + "admin.password": "$2a$10$hDj12Tw9xVmvybSahN1Y0.f9DZixxN8oybyA32Uy/eqWklFU4Mo8O", + "admin.passwordMtime": "'$(date +%FT%T%Z)'" + }}' +argocd login localhost:8080 --username admin --password 'Password1!' +``` + +Create and sync app: + +``` +argocd app create guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --path guestbook --project default --repo https://github.com/argoproj/argocd-example-apps.git +argocd app sync guestbook +``` ## Publishing Changes