Skip to content

Commit bfb731f

Browse files
committed
🤖 docs: avoid literal \n in gh pr comment bodies
Change-Id: Iaa402bb87f8a76413e38f6e4ab94b1c3b6d3eb11 Signed-off-by: Thomas Kosiewski <[email protected]>
1 parent 10ceec3 commit bfb731f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/AGENTS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,15 @@ gh pr view <number> --json mergeable,mergeStateStatus | jq '.'
2929
./scripts/wait_pr_checks.sh <pr_number>
3030
```
3131

32+
- When posting multi-line comments with `gh` (e.g., `@codex review`), **do not** rely on `\n` escapes inside quoted `--body` strings (they will be sent as literal text). Prefer `--body-file -` with a heredoc to preserve real newlines:
33+
34+
```bash
35+
gh pr comment <pr_number> --body-file - <<'EOF'
36+
@codex review
37+
38+
<message>
39+
EOF
40+
```
3241
- If Codex left review comments and you addressed them, push your fixes and then comment `@codex review` to re-request review. After that, re-run `./scripts/wait_pr_checks.sh <pr_number>` and `./scripts/check_codex_comments.sh <pr_number>`.
3342
- Generally run `wait_pr_checks` after submitting a PR to ensure CI passes.
3443
- Status decoding: `mergeable=MERGEABLE` clean; `CONFLICTING` needs resolution. `mergeStateStatus=CLEAN` ready, `BLOCKED` waiting for CI, `BEHIND` rebase, `DIRTY` conflicts.

0 commit comments

Comments
 (0)