Skip to content

Commit 6a5b831

Browse files
leggetterclaude
andcommitted
docs(known-issues): record the rule flag order issue and its fix
Symptom, cause, affected versions (v3.1.0 and earlier), the fix version and a --rules/--rules-file workaround, as the review checklist asks for a change that fixes user-visible behaviour. Addresses Copilot's review finding on #464. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent e18b530 commit 6a5b831

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

‎KNOWN_ISSUES.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,31 @@
11
# Known Issues
22

3+
## Connection rules built from `--rule-*` flags run in a fixed order, not the order you wrote them
4+
5+
**Symptom:** A connection created, updated or upserted with `--rule-*` flags runs its rules in a
6+
different order from the flags. For example, `--rule-filter-body … --rule-transform-name …`
7+
produces a transform rule followed by a filter rule, so the filter sees the transformed payload
8+
instead of the original one.
9+
10+
**Why:** The CLI always built rules as deduplicate, transform, filter, delay, retry, whatever the
11+
order of the flags. Filter, transform and deduplicate rules run in the order they appear in the
12+
connection's `rules` array.
13+
14+
**Affected:** v3.1.0 and earlier. `--rules` and `--rules-file` were not affected: they send the
15+
array exactly as given.
16+
17+
**Recommended fix:** Update to **v3.2.0 or later**. Rules then follow the position of each rule
18+
type's first flag. If you put filter flags before transform flags and relied on transform running
19+
first, put the transform flags first.
20+
21+
- npm: `npm install -g hookdeck-cli@latest`
22+
- Homebrew: `brew upgrade hookdeck`
23+
24+
**Workaround (until you update):** Pass the rules as JSON with `--rules` or `--rules-file`, in the
25+
order you want them to run.
26+
27+
**Tracking:** #464
28+
329
## `hookdeck listen` never prints "Connected" when output is piped or `--color off` is set
430

531
**Symptom:** `hookdeck listen` prints the connection banner and then nothing. The documented

0 commit comments

Comments
 (0)