Improved comments on the label flag.

m-lab · Nov 30, 2018 · 165b8ae · 165b8ae
1 parent a6fe0b2
commit 165b8ae
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/cmd/github_receiver/main.go b/cmd/github_receiver/main.go
@@ -40,7 +40,7 @@ var (
 	enableAutoClose = flag.Bool("enable-auto-close", false, "Once an alert stops firing, automatically close open issues.")
 	enableInMemory  = flag.Bool("enable-inmemory", false, "Perform all operations in memory, without using github API.")
 	receiverPort    = flag.String("port", "9393", "The port for accepting alertmanager webhook messages.")
-	alertLabel      = flag.String("alertlabel", "alert:boom:", "The default label applied to all alerts")
+	alertLabel      = flag.String("alertlabel", "alert:boom:", "The default label applied to all alerts. Also used to search the repo to discover exisitng alerts.")
 	extraLabels     = flag.StringArray("label", nil, "Extra labels to add to issues at creation time.")
 )
 

diff --git a/issues/issues.go b/issues/issues.go
@@ -84,7 +84,8 @@ type Client struct {
 	GithubClient *github.Client
 	// org is the github user or organization name (e.g. github.com/<org>/<repo>).
 	org string
-	// alertLabel is the label applied to all alerts.
+	// alertLabel is the label applied to all alerts.  It is also used as
+	// the label to search to discover all existing alerts.
 	alertLabel string
 }