log a warning when total rate limit is exceeded

Signed-off-by: Lukas Peter Aldershaab <[email protected]>
runatlantis · Jan 17, 2025 · 53f6d4e · 53f6d4e
1 parent b56cb64
commit 53f6d4e
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/server/events/vcs/github_client.go b/server/events/vcs/github_client.go
@@ -125,7 +125,11 @@ func NewGithubClient(hostname string, credentials GithubCredentials, config Gith
 		return nil, errors.Wrap(err, "error initializing github authentication transport")
 	}
 
-	transportWithRateLimit, err := github_ratelimit.NewRateLimitWaiterClient(transport.Transport, github_ratelimit.WithTotalSleepLimit(time.Minute, nil))
+	transportWithRateLimit, err := github_ratelimit.NewRateLimitWaiterClient(
+		transport.Transport,
+		github_ratelimit.WithTotalSleepLimit(time.Minute, func(callbackContext *github_ratelimit.CallbackContext) {
+			logger.Warn("github rate limit exceeded total sleep time, requests will fail to avoid penalties from github")
+		}))
 	if err != nil {
 		return nil, errors.Wrap(err, "error initializing github rate limit transport")
 	}