Skip to content

Commit 4094755

Browse files
committed
Polish post-comment.ts usage comment
1 parent d715939 commit 4094755

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

‎pr-checks/post-comment.ts‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
#!/usr/bin/env npx tsx
22

33
/*
4-
Creates or updates a pull request comment identified by a marker. The marker
5-
is supplied via `--marker` (or the `.github/actions/post-comment` action's `marker` input)
6-
and must be non-empty. Supply a plain-text identifier; the CLI wraps it in a
7-
hidden HTML comment, prepends it to `--body`, and uses it to find the comment on later runs.
8-
Supply `--update-only` to suppress creation; omit it to update or create comments.
4+
Creates or updates a pull-request comment identified by a marker.
5+
6+
The marker is supplied via `--marker` and must be a non-empty plain-text identifier.
7+
The CLI wraps the marker in a hidden HTML comment, prepends it to `--body`,
8+
and uses it to find the comment on later runs.
9+
10+
Supply `--update-only` to suppress creation of comment; omit it
11+
to update or create comments.
912
1013
Example:
1114
```sh

0 commit comments

Comments
 (0)