Helm Diff Notifier is a simple tool based on helm-diff, mainly using in the CI pipeline, to send the helm diff result to GitHub PR review page.
- Could simplify diff result by picking up the key diff lines
- Eventually found there is already a feature in helm-diff, that could simplify the final result by providing option
-C int
- Eventually found there is already a feature in helm-diff, that could simplify the final result by providing option
- Desensitization by using provided rules
Right now it is only supported in CircleCI pipeline, you could config the tool like below:
-
Setup Github Token as
GITHUB_API_TOKEN
in the CircleCI context -
Config CircleCI jobs in
config.yml
to use this tool with helm diff resulthelm diff upgrade -n namespace foo-release | helm-diff-notifier
Prerequisites:
- Docker
This project is fully dockerized. So you could setup your local env by only install Docker.
Basic commands used in local dev:
- enable debug mode,
export HELM_DIFF_DEBUG=true
- run test,
make test
- build local dev image,
make build-dev-image
More commands you could check the details in Makefile