Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tonglil committed Jun 8, 2024
1 parent cb454ba commit fb88628
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions docs/services/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

## Parameters

The GitHub notification service changes commit status using [GitHub Apps](https://docs.github.com/en/developers/apps) and requires specifying the following settings:
The GitHub notification service can notify the following notification types:

- Commit statuses
- Deployments
- Pull request comments

It uses a [GitHub App](https://docs.github.com/en/developers/apps) and requires specifying the following settings:

- `appID` - the app id
- `installationID` - the app installation id
Expand Down Expand Up @@ -46,7 +52,7 @@ stringData:
-----END RSA PRIVATE KEY-----
```
6. Create subscription for your GitHub integration
1. Create subscription for your GitHub integration
```yaml
apiVersion: argoproj.io/v1alpha1
Expand All @@ -56,6 +62,19 @@ metadata:
notifications.argoproj.io/subscribe.<trigger-name>.github: ""
```
By default, the integration updates all configured notification types.
If you have multiple GitHub notification types configured, you can subscribe to a specific type by setting it as the annotation value:
```yaml
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
annotations:
notifications.argoproj.io/subscribe.<trigger-name>.github: "status"
notifications.argoproj.io/subscribe.<trigger-name>.github: "deployment"
notifications.argoproj.io/subscribe.<trigger-name>.github: "comment"
```
## Templates
![](https://user-images.githubusercontent.com/18019529/108520497-168ce180-730e-11eb-93cb-b0b91f99bdc5.png)
Expand Down

0 comments on commit fb88628

Please sign in to comment.