diff --git a/changelog.d/fixed-16761-prow-lgtm-comment.md b/changelog.d/fixed-16761-prow-lgtm-comment.md new file mode 100644 index 0000000000..311b3e7acd --- /dev/null +++ b/changelog.d/fixed-16761-prow-lgtm-comment.md @@ -0,0 +1 @@ +- Corrected the `bindProwLgtm` comment to describe returned reporting errors and best-effort warnings; runtime behavior is unchanged (#16761). diff --git a/src/pkg/github/client.go b/src/pkg/github/client.go index 7224afc0ca..a02ea7755e 100644 --- a/src/pkg/github/client.go +++ b/src/pkg/github/client.go @@ -3356,8 +3356,9 @@ const ( ) // bindProwLgtm records the `prow/lgtm` success status on headSHA, the commit -// the queue review approved. The label and review are already in place, so a -// failure is logged and surfaced on the PR but never returned. +// the queue review approved. On failure it returns the error, logs it when a +// logger is available, and attempts to surface a warning on the PR. The caller +// records the reporting error without undoing the already-placed label and review. func (c *Client) bindProwLgtm(ctx context.Context, owner, repoName string, number int, headSHA, queuedBy string) error { sha7 := headSHA if len(sha7) > 7 {