docs(tools/forge): document read-before-comment guard + --force flag
This commit is contained in:
parent
73a58776fa
commit
d4dd5aad3e
1 changed files with 9 additions and 2 deletions
|
|
@ -31,14 +31,15 @@ hive-forge issue close 42 # close an issue (kind-validated)
|
||||||
hive-forge pr status --pr 42 # PR health (mergeable / CI / reviews)
|
hive-forge pr status --pr 42 # PR health (mergeable / CI / reviews)
|
||||||
hive-forge issue create --title "..." --body "..."
|
hive-forge issue create --title "..." --body "..."
|
||||||
# --- flat aliases below remain valid (hidden) ---
|
# --- flat aliases below remain valid (hidden) ---
|
||||||
hive-forge view 42 # title + body + comments
|
hive-forge view 42 # title + body + comments (marks thread read)
|
||||||
hive-forge comments 42 # list all comments (human-readable)
|
hive-forge comments 42 # list all comments (human-readable; marks thread read)
|
||||||
hive-forge comments 42 --tail 10 # last 10 comments (count-then-page; efficient on long threads)
|
hive-forge comments 42 --tail 10 # last 10 comments (count-then-page; efficient on long threads)
|
||||||
hive-forge --json comments 42 # same as above, JSON array (global flag)
|
hive-forge --json comments 42 # same as above, JSON array (global flag)
|
||||||
hive-forge comment 42 --body "..." # post comment (inline body)
|
hive-forge comment 42 --body "..." # post comment (inline body)
|
||||||
hive-forge comment 42 --body-file - <<EOF # ...or pipe a HEREDOC
|
hive-forge comment 42 --body-file - <<EOF # ...or pipe a HEREDOC
|
||||||
multi-line body
|
multi-line body
|
||||||
EOF
|
EOF
|
||||||
|
hive-forge comment 42 --body "..." --force # post even if thread has unread activity
|
||||||
hive-forge comment-show 18042 # fetch one comment by id
|
hive-forge comment-show 18042 # fetch one comment by id
|
||||||
hive-forge comment-edit 18042 --body "..." # edit a comment
|
hive-forge comment-edit 18042 --body "..." # edit a comment
|
||||||
hive-forge assign 42 damocles
|
hive-forge assign 42 damocles
|
||||||
|
|
@ -141,6 +142,12 @@ plain comment show under `last comment`, not `reviews`.
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
|
- **Read-before-comment guard:** `comment` refuses to post when forge still
|
||||||
|
has an unread notification for the thread (i.e. someone commented since you
|
||||||
|
last read it). This prevents accidentally replying to old activity without
|
||||||
|
seeing the new context. Read the thread with `hive-forge view <n>` or
|
||||||
|
`hive-forge comments <n>` (which mark the notification read and clear the
|
||||||
|
block), or pass `--force` to skip the guard.
|
||||||
- `comment --body "..."` with backticks in the body: always use
|
- `comment --body "..."` with backticks in the body: always use
|
||||||
`--body-file -` with a HEREDOC to avoid shell escaping issues.
|
`--body-file -` with a HEREDOC to avoid shell escaping issues.
|
||||||
- `pr-create --push` also runs `git push forge <head>` and suppresses
|
- `pr-create --push` also runs `git push forge <head>` and suppresses
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue