From 876651691e0816dc32f41479a65da002d859d81d Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Sun, 13 Sep 2026 21:42:58 +0300 Subject: [PATCH] docs: say a piped message is only the message when other checks run `echo "..." | commit-check -m --branch` checks the piped message and the current branch. Before the fix in commit-check, the branch check read the message as the branch name, so this describes behaviour that ships in the next release and must not merge before that release is published. --- docs/example.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/example.md b/docs/example.md index b8cc155..4d47e44 100644 --- a/docs/example.md +++ b/docs/example.md @@ -34,6 +34,14 @@ revision. $ echo "feat(auth): add OAuth2 login" | commit-check -m ``` + Stdin carries the message and nothing else. Other checks in the same run + read the repository, as they do next to a message file, so this checks + the piped message and the current branch: + + ```console + $ echo "feat(auth): add OAuth2 login" | commit-check -m --branch + ``` + === "From a revision" `--rev` names the commit under test — anything `git rev-parse`