From abc378bc11b4521c1960739a365092d2b19282a3 Mon Sep 17 00:00:00 2001 From: Andre Marcelo-Tanner Date: Tue, 20 Feb 2024 23:35:08 -0500 Subject: [PATCH] chore: update contributing docs with notifications engine section Signed-off-by: Andre Marcelo-Tanner --- docs/CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 8eb4a5b96f..f727834d8b 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -247,6 +247,23 @@ pushed into the other kubernetes repositories yet. In order to import the kubern associated repos have to pinned to the correct version specified by the kubernetes/kubernetes release. The `./hack/update-k8s-dependencies.sh` updates all the dependencies to the those correct versions. +## Upgrading Notifications Engine +Argo Rollouts has a dependency on the [argoproj/notifications-engines](https://github.com/argoproj/notifications-engine) repo +for the notifications functionality and related documentation. + +This is updated by upgrading the Go library in `go.mod` by running the commands: + +```shell +go get github.com/argoproj/notifications-engine@LATEST_COMMIT_HASH +go mod tidy +``` + +Next the latest notifications documentation can be imported by running: + +```shell +make docs +``` + ## Documentation Changes Modify contents in `docs/` directory.