Skip to content

Commit

Permalink
chore: update contributing docs with notifications engine section
Browse files Browse the repository at this point in the history
Signed-off-by: Andre Marcelo-Tanner <[email protected]>
  • Loading branch information
kzap committed Feb 21, 2024
1 parent f2e8477 commit abc378b
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit abc378b

Please sign in to comment.