Merge branch 'main' into howon/sahil-ask

Howon Lee · Howon Lee · commit 7edc5df88ddd · 2025-04-22T14:36:27.000-07:00
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -5,6 +5,26 @@ description: The latest updates and changes to CodeRabbit.
 sidebar_position: 13
 ---
 
+## April 19, 2025
+
+### Docstring Path Instructions
+
+You can now provide path-based instructions for the generation of docstring in `.coderabbit.yaml`.
+
+Example:
+
+```yaml
+code_generation:
+  docstrings:
+    path_instructions:
+      - path: "**/*.ts"
+        instructions: |
+          End all docstrings with a notice that says "Auto-generated by CodeRabbit.".
+          Do not omit the closing tags; the docstring must be valid.
+```
+
+See the [docstrings documentation](/finishing-touches/docstrings#path-instructions) for more details.
+
 ## April 14, 2025
 
 ### Shopify CLI Integration & Bitbucket Cloud Reporting
diff --git a/docs/finishing-touches/docstrings.md b/docs/finishing-touches/docstrings.md
@@ -33,6 +33,20 @@ CodeRabbit cannot perform further modifications to opened pull requests. From th
 
 This feature has been rigorously tested and is now available for all Pro plan users. Additionally, you can provide feedback about this feature on [Discord](https://discord.com/channels/1134356397673414807/1317286905557287022).
 
+## Path Instructions
+
+You can customize the generated docstrings by providing instructions based on file paths in your `.coderabbit.yaml`. The `path` is a [minimatch](https://github.com/isaacs/minimatch) pattern.
+
+```yaml
+code_generation:
+  docstrings:
+    path_instructions:
+      - path: "**/*.ts"
+        instructions: |
+          End all docstrings with a notice that says "Auto-generated by CodeRabbit.".
+          Do not omit the closing tags; the docstring must be valid.
+```
+
 ## Supported software forges
 
 These software forges are supported:
diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md
@@ -64,12 +64,17 @@ LLM_PROVIDER=azure-openai
 LLM_TIMEOUT=360000
 AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
 AZURE_OPENAI_API_KEY=<key>
-## it is recommended to use gpt-4o-mini, o3-mini, and o1 deployments.
-AZURE_GPT4OMINI_DEPLOYMENT_NAME=<gpt-4o-mini-deployment-name>
-AZURE_O3MINI_DEPLOYMENT_NAME=<o3-mini-deployment-name>
-AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
-# optionally, you can swap o3-mini with o1-mini
-AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
+## it is recommended to deploy gpt-4.1-mini, o4-mini, o3 deployments, gpt-4.1 (optionally).
+AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
+AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
+AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
+AZURE_GPT41_DEPLOYMENT_NAME=[<gpt-4.1-deployment-name>]
+# optionally, deploy gpt-4o-mini instead of gpt-4.1-mini
+AZURE_GPT4OMINI_DEPLOYMENT_NAME=[<gpt-4o-mini-deployment-name>]
+# optionally, deploy o3-mini instead of o4-mini
+AZURE_O3MINI_DEPLOYMENT_NAME=[<o3-mini-deployment-name>]
+# optionally, deploy o1 instead of o3
+AZURE_O1_DEPLOYMENT_NAME=[<o1-deployment-name>]
 
 # OAuth2 Configuration (optional)
 # This will use client_credentials flow to get an access token,
@@ -107,8 +112,11 @@ AZURE_DEVOPS_BOT_USERNAME=<bot-user-username>
 CODERABBIT_LICENSE_KEY=<license-key>
 
 CODERABBIT_API_KEY=<coderabbitai-api-key>
-ENABLE_LEARNINGS=[true]
 ENABLE_METRICS=[true]
+ENABLE_LEARNINGS=[true]
+# if using CodeRabbit's learnings, also provide the following
+# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
 JIRA_PAT=[<jira-personal-access-token>]
diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md
@@ -56,12 +56,17 @@ LLM_PROVIDER=azure-openai
 LLM_TIMEOUT=360000
 AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
 AZURE_OPENAI_API_KEY=<key>
-## it is recommended to use gpt-4o-mini, o3-mini, and o1 deployments.
-AZURE_GPT4OMINI_DEPLOYMENT_NAME=<gpt-4o-mini-deployment-name>
-AZURE_O3MINI_DEPLOYMENT_NAME=<o3-mini-deployment-name>
-AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
-# optionally, you can swap o3-mini with o1-mini
-AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
+## it is recommended to deploy gpt-4.1-mini, o4-mini, o3 deployments, gpt-4.1 (optionally).
+AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
+AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
+AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
+AZURE_GPT41_DEPLOYMENT_NAME=[<gpt-4.1-deployment-name>]
+# optionally, deploy gpt-4o-mini instead of gpt-4.1-mini
+AZURE_GPT4OMINI_DEPLOYMENT_NAME=[<gpt-4o-mini-deployment-name>]
+# optionally, deploy o3-mini instead of o4-mini
+AZURE_O3MINI_DEPLOYMENT_NAME=[<o3-mini-deployment-name>]
+# optionally, deploy o1 instead of o3
+AZURE_O1_DEPLOYMENT_NAME=[<o1-deployment-name>]
 
 # OAuth2 Configuration (optional)
 # This will use client_credentials flow to get an access token,
@@ -102,8 +107,11 @@ BITBUCKET_SERVER_BOT_USERNAME=<bot-user-username>
 CODERABBIT_LICENSE_KEY=<license-key>
 
 CODERABBIT_API_KEY=<coderabbitai-api-key>
-ENABLE_LEARNINGS=[true]
 ENABLE_METRICS=[true]
+ENABLE_LEARNINGS=[true]
+# if using CodeRabbit's learnings, also provide the following
+# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
 JIRA_PAT=[<jira-personal-access-token>]
diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md
@@ -67,12 +67,17 @@ LLM_PROVIDER=azure-openai
 LLM_TIMEOUT=360000
 AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
 AZURE_OPENAI_API_KEY=<key>
-## it is recommended to use gpt-4o-mini, o3-mini, and o1 deployments.
-AZURE_GPT4OMINI_DEPLOYMENT_NAME=<gpt-4o-mini-deployment-name>
-AZURE_O3MINI_DEPLOYMENT_NAME=<o3-mini-deployment-name>
-AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
-# optionally, you can swap o3-mini with o1-mini
-AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
+## it is recommended to deploy gpt-4.1-mini, o4-mini, o3 deployments, gpt-4.1 (optionally).
+AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
+AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
+AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
+AZURE_GPT41_DEPLOYMENT_NAME=[<gpt-4.1-deployment-name>]
+# optionally, deploy gpt-4o-mini instead of gpt-4.1-mini
+AZURE_GPT4OMINI_DEPLOYMENT_NAME=[<gpt-4o-mini-deployment-name>]
+# optionally, deploy o3-mini instead of o4-mini
+AZURE_O3MINI_DEPLOYMENT_NAME=[<o3-mini-deployment-name>]
+# optionally, deploy o1 instead of o3
+AZURE_O1_DEPLOYMENT_NAME=[<o1-deployment-name>]
 
 # OAuth2 Configuration (optional)
 # This will use client_credentials flow to get an access token,
@@ -120,8 +125,11 @@ GITHUB_APP_PEM_FILE=<flattened-pem-file>
 CODERABBIT_LICENSE_KEY=<license-key>
 
 CODERABBIT_API_KEY=<coderabbitai-api-key>
-ENABLE_LEARNINGS=[true]
 ENABLE_METRICS=[true]
+ENABLE_LEARNINGS=[true]
+# if using CodeRabbit's learnings, also provide the following
+# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
 JIRA_PAT=[<jira-personal-access-token>]
diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md
@@ -62,12 +62,17 @@ LLM_PROVIDER=azure-openai
 LLM_TIMEOUT=360000
 AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
 AZURE_OPENAI_API_KEY=<key>
-## it is recommended to use gpt-4o-mini, o3-mini, and o1 deployments.
-AZURE_GPT4OMINI_DEPLOYMENT_NAME=<gpt-4o-mini-deployment-name>
-AZURE_O3MINI_DEPLOYMENT_NAME=<o3-mini-deployment-name>
-AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
-# optionally, you can swap o3-mini with o1-mini
-AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
+## it is recommended to deploy gpt-4.1-mini, o4-mini, o3 deployments, gpt-4.1 (optionally).
+AZURE_GPT41MINI_DEPLOYMENT_NAME=<gpt-4.1-mini-deployment-name>
+AZURE_O4MINI_DEPLOYMENT_NAME=<o4-mini-deployment-name>
+AZURE_O3_DEPLOYMENT_NAME=<o3-deployment-name>
+AZURE_GPT41_DEPLOYMENT_NAME=[<gpt-4.1-deployment-name>]
+# optionally, deploy gpt-4o-mini instead of gpt-4.1-mini
+AZURE_GPT4OMINI_DEPLOYMENT_NAME=[<gpt-4o-mini-deployment-name>]
+# optionally, deploy o3-mini instead of o4-mini
+AZURE_O3MINI_DEPLOYMENT_NAME=[<o3-mini-deployment-name>]
+# optionally, deploy o1 instead of o3
+AZURE_O1_DEPLOYMENT_NAME=[<o1-deployment-name>]
 
 # OAuth2 Configuration (optional)
 # This will use client_credentials flow to get an access token,
@@ -111,8 +116,11 @@ GITLAB_WEBHOOK_SECRET=<webhook-secret-key>
 CODERABBIT_LICENSE_KEY=<license-key>
 
 CODERABBIT_API_KEY=<coderabbitai-api-key>
-ENABLE_LEARNINGS=[true]
 ENABLE_METRICS=[true]
+ENABLE_LEARNINGS=[true]
+# if using CodeRabbit's learnings, also provide the following
+# For example, s3://bucket/path/to/database, gs://bucket/path/to/database, etc.
+OBJECT_STORE_URI=[<object-store-uri>]
 
 JIRA_HOST=[<jira-host-url>]
 JIRA_PAT=[<jira-personal-access-token>]
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
@@ -830,19 +830,6 @@
 									"additionalProperties": false,
 									"default": {},
 									"description": "Configuration for Shopify Theme Check to ensure theme quality and best practices"
-								},
-								"rustClippy": {
-									"type": "object",
-									"properties": {
-										"enabled": {
-											"type": "boolean",
-											"default": true,
-											"description": "Enable Clippy | Clippy is a linter for Rust code. | v1.86.0"
-										}
-									},
-									"additionalProperties": false,
-									"default": {},
-									"description": "Clippy is a linter for Rust code."
 								}
 							},
 							"additionalProperties": false,
@@ -1110,10 +1097,33 @@
 									],
 									"default": "en-US",
 									"description": "Set the language for docstrings by using the corresponding ISO language code."
+								},
+								"path_instructions": {
+									"type": "array",
+									"items": {
+										"type": "object",
+										"properties": {
+											"path": {
+												"type": "string",
+												"description": "File path glob pattern. Example: **/*.js"
+											},
+											"instructions": {
+												"type": "string",
+												"maxLength": 20000,
+												"description": "Provides additional guidelines for docstring generation based on file paths."
+											}
+										},
+										"required": ["path", "instructions"],
+										"additionalProperties": false
+									},
+									"default": [],
+									"description": "Path Instructions | Provide additional guidelines for docstring generation based on file paths."
 								}
 							},
 							"additionalProperties": false,
-							"default": {},
+							"default": {
+								"path_instructions": []
+							},
 							"description": "Settings related to the generation of docstrings."
 						}
 					},
