From 19e1ab5452dea5c862ca7af856b474750afa1dc4 Mon Sep 17 00:00:00 2001 From: Mario Campos Date: Thu, 29 Oct 2026 10:28:26 -0500 Subject: [PATCH] Update `pr-checks/post-comment.ts` description comment --- pr-checks/post-comment.ts | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/pr-checks/post-comment.ts b/pr-checks/post-comment.ts index 6c9542d29..1b55c13b2 100644 --- a/pr-checks/post-comment.ts +++ b/pr-checks/post-comment.ts @@ -1,17 +1,19 @@ #!/usr/bin/env npx tsx /* -Generic CLI for creating or updating a "sticky" PR comment identified by a hidden -HTML-comment marker. This centralizes the gh api logic previously duplicated across PR-check -workflow steps that each managed their own marked comment (e.g. a CHANGELOG.md modification -warning). +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. The marker is prepended to `--body` and used to find +the comment on later runs. -The marker is passed explicitly via `--marker` and can be any non-empty string, though an -HTML comment (e.g. ``) is recommended so it doesn't render visibly. It is used -both to find a pre-existing comment on the pull request to update, and is automatically prepended to -`--body` when posting or updating a comment so that future invocations can find it again. -The `.github/actions/post-comment` action requires callers to supply this value via its -`marker` input. +Example: +```sh +GH_TOKEN= npx tsx ./pr-checks/post-comment.ts \ + --body "The changelog needs updating." \ + --marker "" \ + --issue-id 123 \ + --repository github/codeql-action +``` */ import assert from "node:assert/strict";