From 4094755f8cb29f0af52fd094a32fd3d0db7e96db Mon Sep 17 00:00:00 2001 From: Mario Campos Date: Mon, 2 Nov 2026 09:19:54 -0600 Subject: [PATCH] Polish `post-comment.ts` usage comment --- pr-checks/post-comment.ts | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/pr-checks/post-comment.ts b/pr-checks/post-comment.ts index 5c3965577..a546c846f 100644 --- a/pr-checks/post-comment.ts +++ b/pr-checks/post-comment.ts @@ -1,11 +1,14 @@ #!/usr/bin/env npx tsx /* -Creates or updates a pull request comment identified by a marker. The marker -is supplied via `--marker` (or the `.github/actions/post-comment` action's `marker` input) -and must be non-empty. Supply a plain-text identifier; the CLI wraps it in a -hidden HTML comment, prepends it to `--body`, and uses it to find the comment on later runs. -Supply `--update-only` to suppress creation; omit it to update or create comments. +Creates or updates a pull-request comment identified by a marker. + +The marker is supplied via `--marker` and must be a non-empty plain-text identifier. +The CLI wraps the marker in a hidden HTML comment, prepends it to `--body`, +and uses it to find the comment on later runs. + +Supply `--update-only` to suppress creation of comment; omit it +to update or create comments. Example: ```sh