Update docs for git notifiers #250
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phillebaba
commented
Sep 21, 2020
| It is important to note that the referenced provider needs to refer to the | ||
| same GitHub repository as the Kustomization originates from. If these do | ||
| not match the notification will fail as the commit id will not be present. | ||
| Currently the provider will only work with Alerts for Kustomization resources as the events have to be linked with a |
There was a problem hiding this comment.
Should this be included?
There was a problem hiding this comment.
Yes this looks ok to me 👍
docs/guides/notifications.md
Outdated
| token: <token> | ||
| ``` | ||
|
|
||
| ### Health checks |
There was a problem hiding this comment.
Need to add some examples how notifications behave when a Kustomization goes from healthy to unhealthy.
|
|
||
| The resulting status will contain information from the event in the format `{{ .Kind }}/{{ .Name }} - {{ .Reason }}`. | ||
| The first image is an example of how it may look like in GitHub while the one below is an example for GitLab. | ||
|  |
There was a problem hiding this comment.
Need to update the image used.
There was a problem hiding this comment.
Let's update the image in a followup PR.
phillebaba
changed the title
stefanprodan
approved these changes
Oct 1, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.