From fb886283682dc686fcfb633f5bacfa1a4ea688b8 Mon Sep 17 00:00:00 2001
From: Tony Li <tony.li@nytimes.com>
Date: Fri, 7 Jun 2024 18:50:13 -0700
Subject: [PATCH] update docs

---
 docs/services/github.md | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/docs/services/github.md b/docs/services/github.md
index 4cd2523..70241b4 100644
--- a/docs/services/github.md
+++ b/docs/services/github.md
@@ -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
@@ -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
@@ -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)