Skip to content

Commit 31b0880

Browse files
jmacdotorgjmacdotorg
authored
Merge branch 'main' into config
2 parents 2617e73 + 228e9f5 commit 31b0880

File tree

3 files changed

+220
-1
lines changed

3 files changed

+220
-1
lines changed

‎docs/guides/review-instructions.md

Lines changed: 219 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,225 @@ instructions besides the standard review.
1919

2020
> For example, you may want to enforce a style guide by file types or directories.
2121
22+
### Default Blocked Paths
23+
24+
By default, CodeRabbit blocks certain file paths and extensions from being reviewed. If you want CodeRabbit to review any of these blocked paths, you can explicitly include them in your Path Filters configuration.
25+
26+
<details>
27+
<summary>View complete list of default blocked paths</summary>
28+
29+
The following paths are blocked by default, grouped by category:
30+
31+
#### Build and Dependency Directories
32+
33+
| Path Pattern | Description |
34+
| --------------------- | -------------------------- |
35+
| `!**/dist/**` | Build output directory |
36+
| `!**/node_modules/**` | Node.js dependencies |
37+
| `!**/.svelte-kit/**` | SvelteKit build directory |
38+
| `!**/.webpack/**` | Webpack build directory |
39+
| `!**/.yarn/**` | Yarn cache directory |
40+
| `!**/.docusaurus/**` | Docusaurus build directory |
41+
| `!**/.temp/**` | Temporary files directory |
42+
| `!**/.cache/**` | Cache directory |
43+
| `!**/.next/**` | Next.js build directory |
44+
| `!**/.nuxt/**` | Nuxt.js build directory |
45+
46+
#### Lock Files
47+
48+
| Path Pattern | Description |
49+
| ----------------------- | ------------------ |
50+
| `!**/package-lock.json` | npm lock file |
51+
| `!**/yarn.lock` | Yarn lock file |
52+
| `!**/pnpm-lock.yaml` | pnpm lock file |
53+
| `!**/bun.lockb` | Bun lock file |
54+
| `!**/*.lock` | Generic lock files |
55+
56+
#### Generated Code
57+
58+
| Path Pattern | Description |
59+
| ---------------------- | -------------------------------------- |
60+
| `!**/generated/**` | Generated code directory |
61+
| `!**/@generated/**` | Generated code directory (alternative) |
62+
| `!**/__generated__/**` | Generated code directory (alternative) |
63+
| `!**/__generated/**` | Generated code directory (alternative) |
64+
| `!**/_generated/**` | Generated code directory (alternative) |
65+
| `!**/gen/**` | Generated code directory (alternative) |
66+
| `!**/@gen/**` | Generated code directory (alternative) |
67+
| `!**/__gen__/**` | Generated code directory (alternative) |
68+
| `!**/__gen/**` | Generated code directory (alternative) |
69+
| `!**/_gen/**` | Generated code directory (alternative) |
70+
71+
#### Binary and Compiled Files
72+
73+
| Path Pattern | Description |
74+
| ------------- | ----------------------- |
75+
| `!**/*.app` | Application bundle |
76+
| `!**/*.bin` | Binary file |
77+
| `!**/*.class` | Java compiled class |
78+
| `!**/*.dll` | Windows dynamic library |
79+
| `!**/*.dylib` | macOS dynamic library |
80+
| `!**/*.exe` | Windows executable |
81+
| `!**/*.o` | Object file |
82+
| `!**/*.so` | Shared object file |
83+
| `!**/*.wasm` | WebAssembly file |
84+
85+
#### Archives and Compressed Files
86+
87+
| Path Pattern | Description |
88+
| ------------ | ----------------------- |
89+
| `!**/*.bz2` | Bzip2 archive |
90+
| `!**/*.gz` | Gzip archive |
91+
| `!**/*.xz` | XZ archive |
92+
| `!**/*.zip` | ZIP archive |
93+
| `!**/*.7z` | 7-Zip archive |
94+
| `!**/*.rar` | RAR archive |
95+
| `!**/*.zst` | Zstandard archive |
96+
| `!**/*.tar` | TAR archive |
97+
| `!**/*.jar` | Java archive |
98+
| `!**/*.war` | Web application archive |
99+
| `!**/*.nar` | NAR archive |
100+
101+
#### Media Files
102+
103+
| Path Pattern | Description |
104+
| ------------ | --------------- |
105+
| `!**/*.mp3` | MP3 audio |
106+
| `!**/*.wav` | WAV audio |
107+
| `!**/*.wma` | WMA audio |
108+
| `!**/*.mp4` | MP4 video |
109+
| `!**/*.avi` | AVI video |
110+
| `!**/*.mkv` | MKV video |
111+
| `!**/*.wmv` | WMV video |
112+
| `!**/*.m4a` | M4A audio |
113+
| `!**/*.m4v` | M4V video |
114+
| `!**/*.3gp` | 3GP video |
115+
| `!**/*.3g2` | 3G2 video |
116+
| `!**/*.rm` | RealMedia video |
117+
| `!**/*.mov` | QuickTime video |
118+
| `!**/*.flv` | Flash video |
119+
| `!**/*.swf` | Flash animation |
120+
| `!**/*.flac` | FLAC audio |
121+
| `!**/*.ogg` | OGG audio |
122+
123+
#### Images and Fonts
124+
125+
| Path Pattern | Description |
126+
| ------------- | ---------------------- |
127+
| `!**/*.ico` | Icon file |
128+
| `!**/*.svg` | SVG image |
129+
| `!**/*.jpeg` | JPEG image |
130+
| `!**/*.jpg` | JPEG image |
131+
| `!**/*.png` | PNG image |
132+
| `!**/*.gif` | GIF image |
133+
| `!**/*.bmp` | BMP image |
134+
| `!**/*.tiff` | TIFF image |
135+
| `!**/*.webm` | WebM image |
136+
| `!**/*.ttf` | TrueType font |
137+
| `!**/*.otf` | OpenType font |
138+
| `!**/*.woff` | Web Open Font Format |
139+
| `!**/*.woff2` | Web Open Font Format 2 |
140+
| `!**/*.eot` | Embedded OpenType font |
141+
142+
#### Documents and Data Files
143+
144+
| Path Pattern | Description |
145+
| --------------- | ----------------------- |
146+
| `!**/*.pdf` | PDF document |
147+
| `!**/*.doc` | Word document |
148+
| `!**/*.docx` | Word document |
149+
| `!**/*.xls` | Excel spreadsheet |
150+
| `!**/*.xlsx` | Excel spreadsheet |
151+
| `!**/*.ppt` | PowerPoint presentation |
152+
| `!**/*.pptx` | PowerPoint presentation |
153+
| `!**/*.csv` | CSV data file |
154+
| `!**/*.tsv` | TSV data file |
155+
| `!**/*.dat` | Data file |
156+
| `!**/*.db` | Database file |
157+
| `!**/*.parquet` | Parquet data file |
158+
159+
#### Development and System Files
160+
161+
| Path Pattern | Description |
162+
| -------------------- | ------------------- |
163+
| `!**/tags` | Tags file |
164+
| `!**/.tags` | Tags file |
165+
| `!**/TAGS` | Tags file |
166+
| `!**/.TAGS` | Tags file |
167+
| `!**/.DS_Store` | macOS system file |
168+
| `!**/.cscope.files` | Cscope files |
169+
| `!**/.cscope.out` | Cscope output |
170+
| `!**/.cscope.in.out` | Cscope input/output |
171+
| `!**/.cscope.po.out` | Cscope output |
172+
| `!**/*.log` | Log file |
173+
| `!**/*.map` | Source map |
174+
| `!**/*.out` | Output file |
175+
| `!**/*.sum` | Checksum file |
176+
| `!**/*.work` | Work file |
177+
| `!**/*.md5sum` | MD5 checksum file |
178+
179+
#### Game and 3D Assets
180+
181+
| Path Pattern | Description |
182+
| ------------------- | ---------------------- |
183+
| `!**/*.tga` | Targa image |
184+
| `!**/*.dds` | DirectDraw surface |
185+
| `!**/*.psd` | Photoshop document |
186+
| `!**/*.fbx` | FBX 3D model |
187+
| `!**/*.obj` | OBJ 3D model |
188+
| `!**/*.blend` | Blender file |
189+
| `!**/*.dae` | COLLADA 3D model |
190+
| `!**/*.gltf` | GL Transmission Format |
191+
| `!**/*.hlsl` | HLSL shader |
192+
| `!**/*.glsl` | GLSL shader |
193+
| `!**/*.unity` | Unity scene |
194+
| `!**/*.umap` | Unreal map |
195+
| `!**/*.prefab` | Unity prefab |
196+
| `!**/*.mat` | Material file |
197+
| `!**/*.shader` | Shader file |
198+
| `!**/*.shadergraph` | Shader graph |
199+
| `!**/*.sav` | Save file |
200+
| `!**/*.scene` | Scene file |
201+
| `!**/*.asset` | Asset file |
202+
203+
#### Python-specific Files
204+
205+
| Path Pattern | Description |
206+
| -------------- | --------------------- |
207+
| `!**/*.pyc` | Python compiled file |
208+
| `!**/*.pyd` | Python dynamic module |
209+
| `!**/*.pyo` | Python optimized file |
210+
| `!**/*.pkl` | Python pickle file |
211+
| `!**/*.pickle` | Python pickle file |
212+
213+
#### Go-specific Files
214+
215+
| Path Pattern | Description |
216+
| ---------------- | ------------------------------- |
217+
| `!**/*.pb.go` | Protocol buffer Go file |
218+
| `!**/*.pb.gw.go` | Protocol buffer gateway Go file |
219+
220+
#### Terraform Files
221+
222+
| Path Pattern | Description |
223+
| ---------------------- | ---------------------- |
224+
| `!**/*.tfstate` | Terraform state file |
225+
| `!**/*.tfstate.backup` | Terraform state backup |
226+
227+
#### Minified Files
228+
229+
| Path Pattern | Description |
230+
| ------------------ | ------------------------------ |
231+
| `!**/*.min.js` | Minified JavaScript |
232+
| `!**/*.min.js.map` | Minified JavaScript source map |
233+
| `!**/*.min.js.css` | Minified CSS |
234+
235+
</details>
236+
237+
You can also edit your path filters directly in the UI by navigating to: **Configuration** > **Review** > **Settings** > **Path Filters**
238+
239+
<img src="/img/guides/path-filters.png" width="600" alt="CircleCI Integration" />
240+
22241
### Sample Usage
23242

24243
:::note

‎docs/guides/setup-best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ CodeRabbit works best when it has a user account all to itself on your Git platf
1818
Your team treats this account as a bot or service account—even on platforms that don't
1919
have a formal concept of separate service accounts, such as Bitbucket Cloud.
2020

21-
If you use GitHub, then CodeRabbit sets up a service account named `CoderabbitAI` for you as soon as you connect your GitHub organization to CodeRabbit. On other platforms, such as Bitbucket Cloud or Gitlab, you must set this account up yourself.
21+
If you use GitHub, then CodeRabbit sets up a service account named `CodeRabbitAI` for you as soon as you connect your GitHub organization to CodeRabbit. On other platforms, such as Bitbucket Cloud or Gitlab, you must set this account up yourself.
2222

2323
For platform-specific instructions about setting up this user, see
2424
[Integrate with Git platforms](/platforms/).

‎static/img/guides/path-filters.png

92.7 KB
Loading

0 commit comments

Comments
 (0)