Repository navigation
Expand file tree
/
Copy path.coderabbit.yaml
More file actions
172 lines (166 loc) · 7.21 KB
/
Copy path.coderabbit.yaml
File metadata and controls
172 lines (166 loc) · 7.21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# CodeRabbit configuration for CyberChef-MCP.
# https://docs.coderabbit.ai/reference/configuration
#
# Alongside copilot-pull-request-reviewer and the self-hosted Antigravity `agy`
# reviewer. Project convention: reply to AND resolve every bot review thread
# before merge, whatever the verdict.
#
# THE LOAD-BEARING SETTING HERE IS `base_branches`. Without it CodeRabbit reviews
# only PRs targeting the default branch, and reported
# "Review skipped: reviews are disabled for this base branch" on PR #41. The whole
# v2.0.0 release train targets a long-lived `release/v2.0.0` integration branch,
# so every PR in it would have gone unreviewed.
#
# profile: assertive — deliberately more thorough than the "chill" default. This
# is a security/cryptography toolkit where a silently wrong decode or cipher
# result is worse than a crash, so extra nitpicks are worth not missing the one
# comment that matters.
# en-US is this project's convention. Note .cspell.json (upstream's file) declares
# "en,en-gb", which loads BOTH dictionaries - so American spellings pass the grammar
# check and upstream's British prose in src/core does too. Nothing conflicts.
language: en-US
tone_instructions: >-
Precise, technical language. No emojis or poems. Prioritize correctness of
cryptographic and data-transformation output, and fork hygiene, over style nits
that ESLint already catches in CI.
reviews:
profile: assertive
request_changes_workflow: false
high_level_summary: true
sequence_diagrams: true
estimate_code_review_effort: true
assess_linked_issues: true
related_issues: true
related_prs: true
suggested_labels: true
auto_apply_labels: false
suggested_reviewers: false
auto_assign_reviewers: false
poem: false
review_status: true
collapse_walkthrough: true
changed_files_summary: true
slop_detection:
enabled: true
auto_review:
enabled: true
auto_incremental_review: true
drafts: false
ignore_title_keywords:
- "WIP"
- "DO NOT REVIEW"
# Without these, only PRs into the default branch are reviewed.
base_branches:
- "master"
- "release/.*"
- "v1\\.9\\.x"
finishing_touches:
docstrings:
enabled: true
unit_tests:
enabled: true
autofix:
enabled: true
simplify:
enabled: false
pre_merge_checks:
title:
mode: warning
description:
mode: warning
issue_assessment:
mode: warning
docstrings:
mode: warning
threshold: 80
custom_checks:
- name: "No hand-edits to synced upstream code"
mode: warning
instructions: >
Files under src/core/** are synced verbatim from gchq/CyberChef by
.github/workflows/upstream-sync.yml. A hand-edit there is silently
reverted on the next sync and permanently forks this repo from
upstream. Flag any change to src/core/** that is not part of an
upstream sync PR. Fixes belong upstream, or in the MCP layer under
src/node/. Pass if the PR title or body identifies it as an upstream
sync.
- name: "No edits to generated files"
mode: warning
instructions: >
src/core/config/OperationConfig.json, src/core/operations/index.mjs and
tests/operations/index.mjs are generated by `npx grunt configTests` and
are gitignored. Flag any PR that adds or edits them directly.
- name: "Async bake call sites"
mode: warning
instructions: >
bake() and NodeRecipe.execute() are async as of upstream v11.0.0. Flag
any call site that uses the return value synchronously, or that calls
.then() on it without awaiting, or that assumes bake throws
synchronously rather than rejecting.
- name: "Per-session MCP HTTP transport"
mode: warning
instructions: >
The Streamable HTTP transport must construct one Server +
StreamableHTTPServerTransport pair per session ID. Sharing a single
instance across clients leaks cross-client response data
(GHSA-345p-7cg4-v4c7) and causes "Server already initialized"
(issue #36). Flag any reintroduction of a shared instance.
- name: "Deprecation entry for breaking MCP changes"
mode: warning
instructions: >
If this PR changes a public MCP tool name, argument shape, or recipe
format, there must be a corresponding entry in src/node/deprecation.mjs
and a CHANGELOG.md note. Pass for internal refactors and additive
changes.
- name: "CHANGELOG entry for user-visible changes"
mode: warning
instructions: >
If this PR changes user-visible behaviour, adds a feature, or fixes a
user-facing bug, CHANGELOG.md should gain an entry under [Unreleased].
Pass for pure-internal refactors, dependency-only bumps with no
behaviour change, or CI/tooling-only changes.
path_filters:
# Reference corpus of external tools; large, vendored, and not our code.
- "!ref-proj/**"
- "!package-lock.json"
- "!src/core/config/OperationConfig.json"
- "!src/core/operations/index.mjs"
- "!tests/operations/index.mjs"
- "!src/core/vendor/**"
path_instructions:
- path: "src/node/mcp-server.mjs"
instructions: >
The MCP server entry point: protocol handling, dynamic tool generation
from OperationConfig, and call dispatch. Tool names are derived by
sanitizeToolName() from operation display names. Flag anything that
could change a public tool name or argument schema without a
deprecation entry, and anything that bypasses the timeout/retry wrapper
in retry.mjs or the worker-pool routing in worker-pool.mjs.
- path: "src/node/transports.mjs"
instructions: >
stdio and Streamable HTTP transport construction. The HTTP branch must
keep per-session Server/transport isolation; see the pre-merge check.
- path: "src/node/deprecation.mjs"
instructions: >
DEP001-DEP008 are the published v2.0.0 breaking-change contract, mirrored
in docs/v2.0.0-breaking-changes.md. Flag any change to a code's meaning
or removalVersion that is not reflected in that document.
- path: "src/core/**"
instructions: >
Synced verbatim from upstream gchq/CyberChef. Do not suggest style,
naming, spelling or refactoring changes here; they would be reverted by the
next sync. In particular this project is en-US but GCHQ writes British
English, so British spellings in these files are correct and must not be
flagged. Only comment if the change itself looks wrong for the sync.
- path: ".github/workflows/**"
instructions: >
Self-hosted runners are used for the `agy` review job, so a workflow that
executes PR-supplied code is a real escalation risk. Flag untrusted
github.event.* data interpolated into run: blocks, use of
pull_request_target with a PR checkout, and any checkout of PR head code
that is subsequently executed.
- path: "tests/mcp/**"
instructions: >
Vitest suite for the MCP layer, gated at 75% lines/statements, 90%
functions, 70% branches. Flag behaviour changes that arrive without
matching tests.