] [-v]
+
+Required:
+ -h GitLab host (e.g. gitlab.example.com)
+ -u Webhook endpoint URL to receive POSTs
+ -s Webhook secret token (used for signature verification)
+
+Authentication (one of):
+ -t Access token (PAT, project, group or OAuth). If omitted, \$GITLAB_TOKEN is used
+ -A Auth header to use. Default detects:
+ PAT → "PRIVATE-TOKEN"
+ anything else → "Authorization: Bearer"
+
+Scope (choose one):
+ -p Project ID or full path (e.g. 42 or group/app)
+ -g Group ID or full path, recurse through all subgroups & projects
+
+Options:
+ -v Verbose output (show individual project IDs in final summary)
+EOF
+ exit 1
+}
+
+HOST="" HOOK_URL="" HOOK_SECRET=""
+TOKEN="${GITLAB_TOKEN:-}" AUTH_HEADER=""
+PROJECT="" GROUP="" VERBOSE=false
+
+while getopts "h:u:s:t:A:p:g:v" opt; do
+ case "$opt" in
+ h) HOST=$OPTARG ;;
+ u) HOOK_URL=$OPTARG ;;
+ s) HOOK_SECRET=$OPTARG ;;
+ t) TOKEN=$OPTARG ;;
+ A) AUTH_HEADER=$OPTARG ;;
+ p) PROJECT=$OPTARG ;;
+ g) GROUP=$OPTARG ;;
+ v) VERBOSE=true ;;
+ *) usage ;;
+ esac
+done
+
+# Mandatory checks
+[[ -z $HOST || -z $HOOK_URL || -z $HOOK_SECRET ]] && usage
+[[ -n $PROJECT && -n $GROUP ]] && usage
+[[ -z $PROJECT && -z $GROUP ]] && usage
+
+# Token handling
+if [[ -z $TOKEN ]]; then
+ echo "[ERROR] No access token provided. Use -t or set \$GITLAB_TOKEN" >&2
+ exit 1
+fi
+
+# Choose header if not forced
+if [[ -z $AUTH_HEADER ]]; then
+ if [[ $TOKEN == glpat-* || $TOKEN == "PAT-"* ]]; then
+ AUTH_HEADER="PRIVATE-TOKEN"
+ else
+ AUTH_HEADER="Authorization: Bearer"
+ fi
+fi
+
+API="https://${HOST}/api/v4"
+CURL_BASE=(curl -sSf --header "${AUTH_HEADER}: ${TOKEN}")
+
+# Track processed projects to avoid duplicates
+declare -A PROCESSED_PROJECTS
+# Track projects where webhooks were successfully added
+WEBHOOK_PROJECTS=()
+# Track projects where webhooks already existed
+EXISTING_WEBHOOK_PROJECTS=()
+# Progress counters
+TOTAL_PROJECTS_FOUND=0
+PROJECTS_PROCESSED=0
+
+##############################################################################
+# Helpers
+##############################################################################
+url_encode() {
+ local string="$1"
+ # URL encode the string using printf and sed
+ printf '%s' "$string" | sed 's/\//%2F/g; s/ /%20/g; s/@/%40/g; s/:/%3A/g; s/#/%23/g; s/?/%3F/g; s/&/%26/g; s/=/%3D/g; s/+/%2B/g'
+}
+
+# Function to handle paginated API calls
+fetch_paginated() {
+ local url=$1
+ local page=1
+ local per_page=100
+
+ while true; do
+ local paginated_url="${url}?per_page=${per_page}&page=${page}"
+
+ # Add existing query params if they exist
+ if [[ "$url" == *"?"* ]]; then
+ paginated_url="${url}&per_page=${per_page}&page=${page}"
+ fi
+
+ local response
+ response=$("${CURL_BASE[@]}" "$paginated_url" 2>/dev/null) || {
+ echo "[ERROR] Failed to fetch page $page from $url" >&2
+ return 1
+ }
+
+ # Check if response is empty array or null
+ if [[ "$response" == "[]" || "$response" == "null" ]]; then
+ break
+ fi
+
+ # Extract results from current page
+ local page_results
+ page_results=$(echo "$response" | jq -r '.[].id' 2>/dev/null) || {
+ echo "[ERROR] Failed to parse JSON response from page $page" >&2
+ return 1
+ }
+
+ # If no results on this page, we're done
+ if [[ -z "$page_results" ]]; then
+ break
+ fi
+
+ # Count projects found and show progress
+ local page_count
+ page_count=$(echo "$page_results" | wc -l)
+ TOTAL_PROJECTS_FOUND=$((TOTAL_PROJECTS_FOUND + page_count))
+ echo "[PROGRESS] Found $page_count projects on page $page (total: $TOTAL_PROJECTS_FOUND)" >&2
+
+ # Output page results
+ echo "$page_results"
+
+ # If we got less than per_page results, we're on the last page
+ local item_count
+ item_count=$(echo "$response" | jq '. | length' 2>/dev/null) || 0
+ if [[ "$item_count" -lt "$per_page" ]]; then
+ break
+ fi
+
+ ((page++))
+ done
+}
+
+create_hook() {
+ local pid=$1
+
+ # Skip if already processed
+ if [[ -n "${PROCESSED_PROJECTS[$pid]:-}" ]]; then
+ return 0
+ fi
+
+ # Mark as processed
+ PROCESSED_PROJECTS[$pid]=1
+ PROJECTS_PROCESSED=$((PROJECTS_PROCESSED + 1))
+
+ local encoded_pid
+ # URL encode if pid is not purely numeric
+ if [[ $pid =~ ^[0-9]+$ ]]; then
+ encoded_pid=$pid
+ else
+ encoded_pid=$(url_encode "$pid")
+ fi
+
+ # Check if webhook already exists
+ local existing_webhooks
+ existing_webhooks=$("${CURL_BASE[@]}" "${API}/projects/${encoded_pid}/hooks" 2>/dev/null) || {
+ echo "[ERROR] Failed to fetch existing webhooks for project $pid" >&2
+ return 1
+ }
+
+ # Check if our webhook URL already exists
+ if echo "$existing_webhooks" | jq -e --arg url "$HOOK_URL" '.[] | select(.url == $url)' >/dev/null 2>&1; then
+ [[ "$VERBOSE" == "true" ]] && echo "[INFO] Webhook already exists for project: $pid" >&2
+ EXISTING_WEBHOOK_PROJECTS+=("$pid")
+ return 0
+ fi
+
+ [[ "$VERBOSE" == "true" ]] && echo "[INFO] Adding webhook to project: $pid" >&2
+
+ "${CURL_BASE[@]}" --request POST \
+ --data-urlencode "url=${HOOK_URL}" \
+ --data "token=${HOOK_SECRET}" \
+ --data "push_events=true" \
+ --data "note_events=true" \
+ --data "issues_events=true" \
+ --data "merge_requests_events=true" \
+ --data "enable_ssl_verification=true" \
+ "${API}/projects/${encoded_pid}/hooks" \
+ >/dev/null
+
+ # Track successful webhook creation
+ WEBHOOK_PROJECTS+=("$pid")
+}
+
+traverse_group() {
+ local gid=$1
+ local encoded_gid
+ # URL encode if gid is not purely numeric
+ if [[ $gid =~ ^[0-9]+$ ]]; then
+ encoded_gid=$gid
+ else
+ encoded_gid=$(url_encode "$gid")
+ fi
+
+ # projects (includes nested sub-groups) - with pagination
+ while IFS= read -r pid; do
+ [[ -n "$pid" ]] && create_hook "$pid"
+ done < <(
+ fetch_paginated "${API}/groups/${encoded_gid}/projects?include_subgroups=true"
+ )
+
+ # recurse explicit subgroups (older GitLab) - with pagination
+ while IFS= read -r sg; do
+ [[ -n "$sg" ]] && traverse_group "$sg"
+ done < <(
+ fetch_paginated "${API}/groups/${encoded_gid}/subgroups"
+ )
+}
+
+##############################################################################
+# Main
+##############################################################################
+echo "[INFO] Starting webhook processing..." >&2
+
+if [[ -n $PROJECT ]]; then
+ echo "[INFO] Processing single project: $PROJECT" >&2
+ create_hook "$PROJECT"
+else
+ echo "[INFO] Processing group and subgroups: $GROUP" >&2
+ traverse_group "$GROUP"
+fi
+
+echo "[INFO] Finished processing all projects" >&2
+
+# Print final summary
+total_projects=$((${#WEBHOOK_PROJECTS[@]} + ${#EXISTING_WEBHOOK_PROJECTS[@]}))
+
+if [[ $total_projects -eq 0 ]]; then
+ echo "[INFO] No projects were processed"
+else
+ if [[ ${#WEBHOOK_PROJECTS[@]} -gt 0 ]]; then
+ if [[ "$VERBOSE" == "true" ]]; then
+ echo "[INFO] Webhooks installed successfully on ${#WEBHOOK_PROJECTS[@]} project(s):"
+ for pid in "${WEBHOOK_PROJECTS[@]}"; do
+ echo " - Project ID: $pid"
+ done
+ else
+ echo "[INFO] Webhooks installed successfully on ${#WEBHOOK_PROJECTS[@]} project(s)"
+ fi
+ fi
+
+ if [[ ${#EXISTING_WEBHOOK_PROJECTS[@]} -gt 0 ]]; then
+ if [[ "$VERBOSE" == "true" ]]; then
+ echo "[INFO] Webhooks already existed on ${#EXISTING_WEBHOOK_PROJECTS[@]} project(s):"
+ for pid in "${EXISTING_WEBHOOK_PROJECTS[@]}"; do
+ echo " - Project ID: $pid"
+ done
+ else
+ echo "[INFO] Webhooks already existed on ${#EXISTING_WEBHOOK_PROJECTS[@]} project(s)"
+ fi
+ fi
+
+ echo "[INFO] Total projects processed: $total_projects"
+fi
diff --git a/static/img/faq/add-repository.png b/static/img/faq/add-repository.png
new file mode 100644
index 00000000..e69c4a7c
Binary files /dev/null and b/static/img/faq/add-repository.png differ
diff --git a/static/img/faq/coderabbit-github-menu.png b/static/img/faq/coderabbit-github-menu.png
new file mode 100644
index 00000000..c599ca95
Binary files /dev/null and b/static/img/faq/coderabbit-github-menu.png differ
diff --git a/static/img/faq/github-app-settings.png b/static/img/faq/github-app-settings.png
new file mode 100644
index 00000000..ff120953
Binary files /dev/null and b/static/img/faq/github-app-settings.png differ
diff --git a/static/img/faq/gitlab-webhook.png b/static/img/faq/gitlab-webhook.png
new file mode 100644
index 00000000..a233f902
Binary files /dev/null and b/static/img/faq/gitlab-webhook.png differ
diff --git a/static/img/faq/seat-assignment.png b/static/img/faq/seat-assignment.png
new file mode 100644
index 00000000..073194be
Binary files /dev/null and b/static/img/faq/seat-assignment.png differ
diff --git a/static/img/faq/select-repos.png b/static/img/faq/select-repos.png
new file mode 100644
index 00000000..1c1222ff
Binary files /dev/null and b/static/img/faq/select-repos.png differ
diff --git a/static/img/getting-started/billing-history.png b/static/img/getting-started/billing-history.png
new file mode 100644
index 00000000..8fd36af6
Binary files /dev/null and b/static/img/getting-started/billing-history.png differ
diff --git a/static/img/getting-started/change-plan.png b/static/img/getting-started/change-plan.png
new file mode 100644
index 00000000..e41f00ce
Binary files /dev/null and b/static/img/getting-started/change-plan.png differ
diff --git a/static/img/getting-started/change-seats.png b/static/img/getting-started/change-seats.png
new file mode 100644
index 00000000..cc736ac5
Binary files /dev/null and b/static/img/getting-started/change-seats.png differ
diff --git a/static/img/getting-started/download-invoice.png b/static/img/getting-started/download-invoice.png
new file mode 100644
index 00000000..5451693d
Binary files /dev/null and b/static/img/getting-started/download-invoice.png differ
diff --git a/static/img/getting-started/edit-subscription.png b/static/img/getting-started/edit-subscription.png
new file mode 100644
index 00000000..065d0cc2
Binary files /dev/null and b/static/img/getting-started/edit-subscription.png differ
diff --git a/static/img/getting-started/manage-subscription.png b/static/img/getting-started/manage-subscription.png
new file mode 100644
index 00000000..1234acf9
Binary files /dev/null and b/static/img/getting-started/manage-subscription.png differ
diff --git a/static/img/getting-started/quickstart-comment.png b/static/img/getting-started/quickstart-comment.png
new file mode 100644
index 00000000..9813172b
Binary files /dev/null and b/static/img/getting-started/quickstart-comment.png differ
diff --git a/static/img/getting-started/subscription-page.png b/static/img/getting-started/subscription-page.png
new file mode 100644
index 00000000..8fb90f96
Binary files /dev/null and b/static/img/getting-started/subscription-page.png differ
diff --git a/static/img/getting-started/updated-permissions.png b/static/img/getting-started/updated-permissions.png
new file mode 100644
index 00000000..37ef9038
Binary files /dev/null and b/static/img/getting-started/updated-permissions.png differ
diff --git a/static/img/guides/agentic-thought-chain.png b/static/img/guides/agentic-thought-chain.png
new file mode 100644
index 00000000..1fd49a55
Binary files /dev/null and b/static/img/guides/agentic-thought-chain.png differ
diff --git a/static/img/guides/chat-example.png b/static/img/guides/chat-example.png
new file mode 100644
index 00000000..3acb40e1
Binary files /dev/null and b/static/img/guides/chat-example.png differ
diff --git a/static/img/guides/chat-learnings-use.png b/static/img/guides/chat-learnings-use.png
new file mode 100644
index 00000000..f1b3a2f1
Binary files /dev/null and b/static/img/guides/chat-learnings-use.png differ
diff --git a/static/img/guides/chat-script-execution.png b/static/img/guides/chat-script-execution.png
new file mode 100644
index 00000000..4cd29f97
Binary files /dev/null and b/static/img/guides/chat-script-execution.png differ
diff --git a/static/img/guides/create-issue-agentic.png b/static/img/guides/create-issue-agentic.png
new file mode 100644
index 00000000..a7ad04ae
Binary files /dev/null and b/static/img/guides/create-issue-agentic.png differ
diff --git a/static/img/guides/create-issue-inline.png b/static/img/guides/create-issue-inline.png
new file mode 100644
index 00000000..873df82f
Binary files /dev/null and b/static/img/guides/create-issue-inline.png differ
diff --git a/static/img/guides/example-report-1.png b/static/img/guides/example-report-1.png
new file mode 100644
index 00000000..d88931a5
Binary files /dev/null and b/static/img/guides/example-report-1.png differ
diff --git a/static/img/guides/example-report-2.png b/static/img/guides/example-report-2.png
new file mode 100644
index 00000000..98a54896
Binary files /dev/null and b/static/img/guides/example-report-2.png differ
diff --git a/static/img/guides/feature-planning.png b/static/img/guides/feature-planning.png
new file mode 100644
index 00000000..017d3e4b
Binary files /dev/null and b/static/img/guides/feature-planning.png differ
diff --git a/static/img/guides/gitlab-issue-chat.png b/static/img/guides/gitlab-issue-chat.png
new file mode 100644
index 00000000..0b6a1f69
Binary files /dev/null and b/static/img/guides/gitlab-issue-chat.png differ
diff --git a/static/img/guides/high-level-docs.png b/static/img/guides/high-level-docs.png
new file mode 100644
index 00000000..702c5dee
Binary files /dev/null and b/static/img/guides/high-level-docs.png differ
diff --git a/static/img/guides/linked-issue.png b/static/img/guides/linked-issue.png
new file mode 100644
index 00000000..ba585890
Binary files /dev/null and b/static/img/guides/linked-issue.png differ
diff --git a/static/img/guides/marketing-posts.png b/static/img/guides/marketing-posts.png
new file mode 100644
index 00000000..ce607fd4
Binary files /dev/null and b/static/img/guides/marketing-posts.png differ
diff --git a/static/img/guides/open-source-support.png b/static/img/guides/open-source-support.png
new file mode 100644
index 00000000..14c35530
Binary files /dev/null and b/static/img/guides/open-source-support.png differ
diff --git a/static/img/guides/path-filters.png b/static/img/guides/path-filters.png
new file mode 100644
index 00000000..9f398a51
Binary files /dev/null and b/static/img/guides/path-filters.png differ
diff --git a/static/img/guides/score-card-report-result.png b/static/img/guides/score-card-report-result.png
new file mode 100644
index 00000000..15b51539
Binary files /dev/null and b/static/img/guides/score-card-report-result.png differ
diff --git a/static/img/guides/score-card-result-comment.png b/static/img/guides/score-card-result-comment.png
new file mode 100644
index 00000000..1ea43248
Binary files /dev/null and b/static/img/guides/score-card-result-comment.png differ
diff --git a/static/img/guides/score-card-trigger-comment.png b/static/img/guides/score-card-trigger-comment.png
new file mode 100644
index 00000000..2f690948
Binary files /dev/null and b/static/img/guides/score-card-trigger-comment.png differ
diff --git a/static/img/guides/where-score-report-prompt-go.png b/static/img/guides/where-score-report-prompt-go.png
new file mode 100644
index 00000000..3b26a1f1
Binary files /dev/null and b/static/img/guides/where-score-report-prompt-go.png differ
diff --git a/static/img/integrations/azure-access-token.png b/static/img/integrations/azure-access-token.png
index 9ce2b44b..2b3111b1 100644
Binary files a/static/img/integrations/azure-access-token.png and b/static/img/integrations/azure-access-token.png differ
diff --git a/static/img/integrations/bitbucket-app-password-modal.png b/static/img/integrations/bitbucket-app-password-modal.png
new file mode 100644
index 00000000..fd6c556b
Binary files /dev/null and b/static/img/integrations/bitbucket-app-password-modal.png differ
diff --git a/static/img/integrations/bitbucket-app-password-page.png b/static/img/integrations/bitbucket-app-password-page.png
new file mode 100644
index 00000000..c9e25cbe
Binary files /dev/null and b/static/img/integrations/bitbucket-app-password-page.png differ
diff --git a/static/img/integrations/bitbucket-app-password-permissions.png b/static/img/integrations/bitbucket-app-password-permissions.png
new file mode 100644
index 00000000..7e27e6af
Binary files /dev/null and b/static/img/integrations/bitbucket-app-password-permissions.png differ
diff --git a/static/img/integrations/bitbucket-webhook.png b/static/img/integrations/bitbucket-webhook.png
new file mode 100644
index 00000000..687c9b78
Binary files /dev/null and b/static/img/integrations/bitbucket-webhook.png differ
diff --git a/static/img/integrations/login-self-hosted-github.png b/static/img/integrations/login-self-hosted-github.png
index 99f511c6..35e76ed1 100644
Binary files a/static/img/integrations/login-self-hosted-github.png and b/static/img/integrations/login-self-hosted-github.png differ
diff --git a/static/img/integrations/logo.png b/static/img/integrations/logo.png
new file mode 100644
index 00000000..18eb4911
Binary files /dev/null and b/static/img/integrations/logo.png differ
diff --git a/static/img/integrations/self-hosted-github-host-url.png b/static/img/integrations/self-hosted-github-host-url.png
index b8224720..2cb6d671 100644
Binary files a/static/img/integrations/self-hosted-github-host-url.png and b/static/img/integrations/self-hosted-github-host-url.png differ
diff --git a/static/img/knowledge-base/code-guidelines.png b/static/img/knowledge-base/code-guidelines.png
new file mode 100644
index 00000000..638a656f
Binary files /dev/null and b/static/img/knowledge-base/code-guidelines.png differ
diff --git a/static/img/reference/path-instructions.png b/static/img/reference/path-instructions.png
new file mode 100644
index 00000000..adcb5884
Binary files /dev/null and b/static/img/reference/path-instructions.png differ
diff --git a/static/img/tools/az-devops-pipeline.png b/static/img/tools/az-devops-pipeline.png
new file mode 100644
index 00000000..b06dafab
Binary files /dev/null and b/static/img/tools/az-devops-pipeline.png differ
diff --git a/static/img/tools/circle-cicd.png b/static/img/tools/circle-cicd.png
new file mode 100644
index 00000000..9af6cf95
Binary files /dev/null and b/static/img/tools/circle-cicd.png differ
diff --git a/static/img/tools/docker-build-cicd.png b/static/img/tools/docker-build-cicd.png
new file mode 100644
index 00000000..01e6ed58
Binary files /dev/null and b/static/img/tools/docker-build-cicd.png differ
diff --git a/static/img/tools/gitlab-advanced-security.png b/static/img/tools/gitlab-advanced-security.png
new file mode 100644
index 00000000..94dc3d75
Binary files /dev/null and b/static/img/tools/gitlab-advanced-security.png differ
diff --git a/static/img/tools/gitlab-cicd.png b/static/img/tools/gitlab-cicd.png
new file mode 100644
index 00000000..0f9c029f
Binary files /dev/null and b/static/img/tools/gitlab-cicd.png differ
diff --git a/static/img/tools/java-cicd.png b/static/img/tools/java-cicd.png
new file mode 100644
index 00000000..b90ec904
Binary files /dev/null and b/static/img/tools/java-cicd.png differ
diff --git a/static/img/tools/kubernetes-cicd.png b/static/img/tools/kubernetes-cicd.png
new file mode 100644
index 00000000..3b8beb53
Binary files /dev/null and b/static/img/tools/kubernetes-cicd.png differ
diff --git a/static/img/tools/npm-cicd.png b/static/img/tools/npm-cicd.png
new file mode 100644
index 00000000..f0402362
Binary files /dev/null and b/static/img/tools/npm-cicd.png differ
diff --git a/static/img/tools/python-cicd.png b/static/img/tools/python-cicd.png
new file mode 100644
index 00000000..cab40924
Binary files /dev/null and b/static/img/tools/python-cicd.png differ
diff --git a/static/img/tools/semgrep-cicd.png b/static/img/tools/semgrep-cicd.png
new file mode 100644
index 00000000..261cfb5e
Binary files /dev/null and b/static/img/tools/semgrep-cicd.png differ
diff --git a/static/img/tools/terraform-cicd.png b/static/img/tools/terraform-cicd.png
new file mode 100644
index 00000000..ede7a0c2
Binary files /dev/null and b/static/img/tools/terraform-cicd.png differ
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
index 53e51713..67d98b12 100644
--- a/static/schema/schema.v2.json
+++ b/static/schema/schema.v2.json
@@ -82,6 +82,8 @@
"zh",
"crh-UA",
"crh",
+ "cs-CZ",
+ "cs",
"nb",
"no",
"nl-NL",
@@ -91,7 +93,19 @@
"fa-IR",
"sv-SE",
"de-LU",
- "fr-FR"
+ "fr-FR",
+ "bg-BG",
+ "bg",
+ "he-IL",
+ "he",
+ "hi-IN",
+ "hi",
+ "vi-VN",
+ "vi",
+ "th-TH",
+ "th",
+ "bn-BD",
+ "bn"
],
"default": "en-US",
"description": "Set the language for reviews by using the corresponding ISO language code."
@@ -211,6 +225,11 @@
"default": true,
"description": "Suggest reviewers based on the changes in the pull request in the walkthrough."
},
+ "auto_assign_reviewers": {
+ "type": "boolean",
+ "default": false,
+ "description": "Automatically assign suggested reviewers to the pull request"
+ },
"poem": {
"type": "boolean",
"default": true,
@@ -243,7 +262,7 @@
"type": "string"
},
"default": [],
- "description": "Specify file patterns to exclude or include for a review. Accepts glob patterns. Example: !dist/**, src/**"
+ "description": "Specify file patterns to include or exclude in a review using glob patterns (e.g., !dist/**, src/**). These patterns also apply to 'git sparse-checkout', including specified patterns and ignoring excluded ones (starting with '!') when cloning the repository."
},
"path_instructions": {
"type": "array",
@@ -256,7 +275,7 @@
},
"instructions": {
"type": "string",
- "maxLength": 3000,
+ "maxLength": 20000,
"description": "Provides specific additional guidelines for code review based on file paths."
}
},
@@ -271,6 +290,11 @@
"default": true,
"description": "Abort the in-progress review if the pull request is closed or merged."
},
+ "disable_cache": {
+ "type": "boolean",
+ "default": false,
+ "description": "Disable caching of code and dependencies. This will force CodeRabbit to download the code and dependencies fresh from the repository each time."
+ },
"auto_review": {
"type": "object",
"properties": {
@@ -332,6 +356,19 @@
"additionalProperties": false,
"default": {},
"description": "Docstrings | Options for generating Docstrings for your PRs/MRs."
+ },
+ "unit_tests": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Unit Tests | Allow CodeRabbit to generate unit tests for PRs/MRs."
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Unit Tests | Options for generating unit tests for your PRs/MRs."
}
},
"additionalProperties": false,
@@ -348,6 +385,7 @@
"items": {
"type": "string"
},
+ "default": [],
"description": "List of rules directories."
},
"util_dirs": {
@@ -355,6 +393,7 @@
"items": {
"type": "string"
},
+ "default": [],
"description": "List of utils directories."
},
"essential_rules": {
@@ -372,7 +411,8 @@
}
},
"additionalProperties": false,
- "description": "Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.31.1"
+ "default": {},
+ "description": "Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.38.6"
},
"shellcheck": {
"type": "object",
@@ -393,7 +433,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Ruff | Ruff is a Python linter and code formatter. | Enable Ruff integration. | v0.8.2"
+ "description": "Enable Ruff | Ruff is a Python linter and code formatter. | Enable Ruff integration. | v0.12.2"
}
},
"additionalProperties": false,
@@ -423,10 +463,10 @@
},
"timeout_ms": {
"type": "number",
- "maximum": 300000,
+ "maximum": 900000,
"minimum": 0,
"default": 90000,
- "description": "Time in milliseconds to wait for all GitHub Checks to conclude."
+ "description": "Time in milliseconds to wait for all GitHub Checks to conclude. Default 90 seconds, max 15 minutes (900000ms)."
}
},
"additionalProperties": false,
@@ -446,6 +486,7 @@
"items": {
"type": "string"
},
+ "default": [],
"description": "IDs of rules to be enabled. The rule won't run unless 'level' is set to a level that activates the rule."
},
"disabled_rules": {
@@ -453,6 +494,7 @@
"items": {
"type": "string"
},
+ "default": [],
"description": "IDs of rules to be disabled. Note: EN_UNPAIRED_BRACKETS, and EN_UNPAIRED_QUOTES are always disabled."
},
"enabled_categories": {
@@ -460,6 +502,7 @@
"items": {
"type": "string"
},
+ "default": [],
"description": "IDs of categories to be enabled."
},
"disabled_categories": {
@@ -467,6 +510,7 @@
"items": {
"type": "string"
},
+ "default": [],
"description": "IDs of categories to be disabled. Note: TYPOS, TYPOGRAPHY, and CASING are always disabled."
},
"enabled_only": {
@@ -534,7 +578,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable PHPStan | PHPStan requires [config file](https://phpstan.org/config-reference#config-file) in your repository root. Please ensure that this file contains the `paths:` parameter. | v2.0.3"
+ "description": "Enable PHPStan | PHPStan requires [config file](https://phpstan.org/config-reference#config-file) in your repository root. Please ensure that this file contains the `paths:` parameter. | v2.1.17"
},
"level": {
"type": "string",
@@ -560,13 +604,39 @@
"default": {},
"description": "PHPStan is a tool to analyze PHP code."
},
+ "phpmd": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable PHPMD | PHPMD is a tool to find potential problems in PHP code. | v2.15.0"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "PHPMD is a tool to find potential problems in PHP code."
+ },
+ "phpcs": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable PHP CodeSniffer | PHP CodeSniffer is a PHP linter and coding standard checker. | v3.7.2"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "PHP CodeSniffer is a PHP linter and coding standard checker."
+ },
"golangci-lint": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v1.62.2"
+ "description": "Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v1.64.8"
},
"config_file": {
"type": "string",
@@ -583,7 +653,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable YAMLlint | YAMLlint is a linter for YAML files. | Enable YAMLlint integration. | v1.35.1"
+ "description": "Enable YAMLlint | YAMLlint is a linter for YAML files. | Enable YAMLlint integration. | v1.37.1"
}
},
"additionalProperties": false,
@@ -596,7 +666,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Gitleaks | Gitleaks is a secret scanner. | Enable Gitleaks integration. | v8.21.2"
+ "description": "Enable Gitleaks | Gitleaks is a secret scanner. | Enable Gitleaks integration. | v8.27.2"
}
},
"additionalProperties": false,
@@ -622,7 +692,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable detekt | detekt is a static code analysis tool for Kotlin files. | v1.23.7"
+ "description": "Enable detekt | detekt is a static code analysis tool for Kotlin files. | v1.23.8"
},
"config_file": {
"type": "string",
@@ -646,13 +716,26 @@
"default": {},
"description": "ESLint is a static code analysis tool for JavaScript files."
},
+ "flake8": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Flake8 | Flake8 is a Python linter that wraps PyFlakes, pycodestyle and Ned Batchelder's McCabe script. | v7.2.0"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Flake8 is a Python linter that wraps PyFlakes, pycodestyle and Ned Batchelder's McCabe script."
+ },
"rubocop": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable RuboCop | RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. | v1.69.1"
+ "description": "Enable RuboCop | RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. | v1.76.1"
}
},
"additionalProperties": false,
@@ -665,7 +748,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Buf | Buf offers linting for Protobuf files. | v1.47.2"
+ "description": "Enable Buf | Buf offers linting for Protobuf files. | v1.55.1"
}
},
"additionalProperties": false,
@@ -678,7 +761,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Regal | Regal is a linter and language server for Rego. | v0.29.2"
+ "description": "Enable Regal | Regal is a linter and language server for Rego. | v0.35.1"
}
},
"additionalProperties": false,
@@ -691,7 +774,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable actionlint | is a static checker for GitHub Actions workflow files. | v1.7.4"
+ "description": "Enable actionlint | is a static checker for GitHub Actions workflow files. | v1.7.7"
}
},
"additionalProperties": false,
@@ -704,7 +787,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable PMD | PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. | v7.8.0"
+ "description": "Enable PMD | PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. | v7.15.0"
},
"config_file": {
"type": "string",
@@ -721,7 +804,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Cppcheck | Cppcheck is a static code analysis tool for the C and C++ programming languages. | v2.10-2"
+ "description": "Enable Cppcheck | Cppcheck is a static code analysis tool for the C and C++ programming languages. | v2.17.1"
}
},
"additionalProperties": false,
@@ -734,7 +817,7 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.99.0"
+ "description": "Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.122.0"
},
"config_file": {
"type": "string",
@@ -751,17 +834,165 @@
"enabled": {
"type": "boolean",
"default": true,
- "description": "Enable CircleCI | CircleCI tool is a static checker for CircleCI config files. | v0.1.31151"
+ "description": "Enable CircleCI | CircleCI tool is a static checker for CircleCI config files. | v0.1.32638"
}
},
"additionalProperties": false,
"default": {},
"description": "CircleCI tool is a static checker for CircleCI config files."
+ },
+ "clippy": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Clippy | Clippy is a collection of lints to catch common mistakes and improve your Rust code. | Enable Clippy integration."
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Clippy is a collection of lints to catch common mistakes and improve your Rust code."
+ },
+ "sqlfluff": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable SQLFluff | SQLFluff is an open source, dialect-flexible and configurable SQL linter. | v3.4.1"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "SQLFluff is an open source, dialect-flexible and configurable SQL linter."
+ },
+ "prismaLint": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Prisma Schema linting | Prisma Schema linting helps maintain consistent and error-free schema files | v0.10.2"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Configuration for Prisma Schema linting to ensure schema file quality"
+ },
+ "pylint": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Pylint | Pylint is a Python static code analysis tool. | v3.3.7"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Pylint is a Python static code analysis tool."
+ },
+ "oxc": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Oxlint | Oxlint is a JavaScript/TypeScript linter for OXC written in Rust. | v0.16.10"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Oxlint is a JavaScript/TypeScript linter for OXC written in Rust."
+ },
+ "shopifyThemeCheck": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Shopify Theme Check | A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices | cli 3.77.1 | theme 3.58.2"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Configuration for Shopify Theme Check to ensure theme quality and best practices"
+ },
+ "luacheck": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Lua code linting | Luacheck helps maintain consistent and error-free Lua code | v1.2.0"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Configuration for Lua code linting to ensure code quality"
+ },
+ "brakeman": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable Brakeman | Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v7.0.2"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v7.0.2"
+ },
+ "dotenvLint": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable dotenv-linter | dotenv-linter is a tool for checking and fixing .env files for problems and best practices | v3.3.0"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "dotenv-linter is a tool for checking and fixing .env files for problems and best practices"
+ },
+ "htmlhint": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable HTMLHint | HTMLHint is a static code analysis tool for HTML files. | Enable HTMLHint integration. | v1.5.0"
+ }
+ },
+ "additionalProperties": false,
+ "description": "HTMLHint is a static code analysis tool for HTML files.",
+ "default": {}
+ },
+ "checkmake": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enable checkmake | checkmake is a linter for Makefiles. | v0.2.2"
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "checkmake is a linter for Makefiles."
}
},
"additionalProperties": false,
"description": "Tools that provide additional context to code reviews.",
"default": {}
+ },
+ "pre_merge_checks": {
+ "type": "object",
+ "additionalProperties": {},
+ "default": {}
}
},
"additionalProperties": false,
@@ -819,7 +1050,40 @@
"opt_out": {
"type": "boolean",
"default": false,
- "description": "Opt out | Opt out of all knowledge base features."
+ "description": "Opt Out | Disable all knowledge base features that require data retention. If you opt out after opting in, all of your existing knowledge base data will be removed from the system."
+ },
+ "web_search": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Web Search | Enable the web search integration."
+ }
+ },
+ "additionalProperties": false,
+ "default": {}
+ },
+ "code_guidelines": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Enabled | Enable CodeRabbit to enforce your organization's coding standards during reviews."
+ },
+ "filePatterns": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": [],
+ "description": "File Patterns | Specify files for your coding guideline documents in this section. CodeRabbit will scan these files to understand your team's standards and apply them during code reviews. Multiple files supported. File names are case-sensitive. Common files like: (**/.cursorrules, .github/copilot-instructions.md, **/CLAUDE.md, **/GEMINI.md, **/.cursor/rules/*, **/.windsurfrules, **/.clinerules/*, **/.rules/*, **/AGENT.md) are included by default."
+ }
+ },
+ "additionalProperties": false,
+ "default": {},
+ "description": "CodeRabbit will analyse and learn from your organization's code guidelines, which you can mention in the file patterns section. These guidelines will then be used to conduct thorough code reviews."
},
"learnings": {
"type": "object",
@@ -905,9 +1169,184 @@
},
"additionalProperties": false,
"default": {}
+ },
+ "code_generation": {
+ "type": "object",
+ "properties": {
+ "docstrings": {
+ "type": "object",
+ "properties": {
+ "language": {
+ "type": "string",
+ "enum": [
+ "de",
+ "de-DE",
+ "de-AT",
+ "de-CH",
+ "en",
+ "en-US",
+ "en-AU",
+ "en-GB",
+ "en-CA",
+ "en-NZ",
+ "en-ZA",
+ "es",
+ "es-AR",
+ "fr",
+ "fr-CA",
+ "fr-CH",
+ "fr-BE",
+ "nl",
+ "nl-BE",
+ "pt-AO",
+ "pt",
+ "pt-BR",
+ "pt-MZ",
+ "pt-PT",
+ "ar",
+ "ast-ES",
+ "ast",
+ "be-BY",
+ "be",
+ "br-FR",
+ "br",
+ "ca-ES",
+ "ca",
+ "ca-ES-valencia",
+ "ca-ES-balear",
+ "da-DK",
+ "da",
+ "de-DE-x-simple-language",
+ "el-GR",
+ "el",
+ "eo",
+ "fa",
+ "ga-IE",
+ "ga",
+ "gl-ES",
+ "gl",
+ "it",
+ "ja-JP",
+ "ja",
+ "km-KH",
+ "km",
+ "ko-KR",
+ "ko",
+ "pl-PL",
+ "pl",
+ "ro-RO",
+ "ro",
+ "ru-RU",
+ "ru",
+ "sk-SK",
+ "sk",
+ "sl-SI",
+ "sl",
+ "sv",
+ "ta-IN",
+ "ta",
+ "tl-PH",
+ "tl",
+ "tr",
+ "uk-UA",
+ "uk",
+ "zh-CN",
+ "zh",
+ "crh-UA",
+ "crh",
+ "cs-CZ",
+ "cs",
+ "nb",
+ "no",
+ "nl-NL",
+ "de-DE-x-simple-language-DE",
+ "es-ES",
+ "it-IT",
+ "fa-IR",
+ "sv-SE",
+ "de-LU",
+ "fr-FR",
+ "bg-BG",
+ "bg",
+ "he-IL",
+ "he",
+ "hi-IN",
+ "hi",
+ "vi-VN",
+ "vi",
+ "th-TH",
+ "th",
+ "bn-BD",
+ "bn"
+ ],
+ "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": {
+ "path_instructions": []
+ },
+ "description": "Settings related to the generation of docstrings."
+ },
+ "unit_tests": {
+ "type": "object",
+ "properties": {
+ "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 unit test generation based on file paths."
+ }
+ },
+ "required": ["path", "instructions"],
+ "additionalProperties": false
+ },
+ "default": [],
+ "description": "Unit Test Generation | Provide additional guidelines for unit test generation based on file paths."
+ }
+ },
+ "additionalProperties": false,
+ "default": {
+ "path_instructions": []
+ },
+ "description": "Settings related to the generation of unit tests."
+ }
+ },
+ "additionalProperties": false,
+ "default": {}
}
},
- "additionalProperties": false
+ "additionalProperties": true
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy
+
### Sample Usage
:::note
diff --git a/docs/guides/roles.md b/docs/guides/roles.md
new file mode 100644
index 00000000..c919f57d
--- /dev/null
+++ b/docs/guides/roles.md
@@ -0,0 +1,138 @@
+---
+title: Control administrative access
+description: Using the role-based authorization features of CodeRabbit
+---
+
+You can control which CodeRabbit
+administrative features are available to your organization's user accounts by
+assigning and updating account roles.
+
+## Overview of CodeRabbit roles {#overview}
+
+Every CodeRabbit account has exactly one role for each organization
+that account is associated with.
+For example, if you belong to two GitHub-based organizations that use
+CodeRabbit, then you have one CodeRabbit role set for each of those two
+organizations.
+
+CodeRabbit roles determine your ability to read or change various
+billing, account management, and other administrative functions related to
+an organization. The roles are as follows:
+
+- **Admin**: allows full read/write access to all CodeRabbit administrative features.
+- **Member**: allows read-only access to a limited set of administrative settings. This role
+ is appropriate for most developers in an organization.
+- **Billing Admin**: allows read/write access to features specific
+ to a subscription and billing management, and limited access to other administrative features.
+
+CodeRabbit users with the **Admin** role can modify the roles of other users in the
+organization.
+
+For a complete list of the administrative functions available to each role, see
+[Role permissions](#permissions).
+
+### CodeRabbit roles and Git platform roles {#and-upstream}
+
+Modifying an account's CodeRabbit role doesn't have any "upstream"
+effect on that account's role or permissions in your organization's Git platform.
+Similarly, changes to an account's role on your organization's Git platform don't
+affect that account's CodeRabbit role.
+
+For example, if you have CodeRabbit integrated with a GitHub organization, and you change an account's CodeRabbit role from **Member** to **Admin**, then that account's
+permission or ownership level with your GitHub organization doesn't change as a result.
+
+### CodeRabbit roles and developer features {#and-features}
+
+CodeRabbit roles affect only access to administrative features. Roles have no effect on using CodeRabbit developer features, such as automated code reviews.
+
+For example, if an organization has a Pro-tier
+CodeRabbit account, then any user account with a seat assigned to it can use Pro-tier features with the organization's private repositories, regardless of that account's role.
+
+For more information on seat and subscription management, see [Manage your subscription](/getting-started/subscription-management).
+
+## Default roles {#defaults}
+
+CodeRabbit assigns every user account in your organization a default role,
+using the following metrics:
+
+- If a user has an ownership-level role with the Git platform organization—for example,
+ **Admin** on GitHub, or **Owner** on Bitbucket—then that user receives the default
+ CodeRabbit role of **Admin**.
+- Otherwise, the user receives the **Member** role by default.
+
+You can update a user's role from its default setting by following the steps detailed in the next section. This requires that your own account
+has an **Admin** role with the organization.
+
+CodeRabbit applies these defaults only when initially setting up for an
+account within an organization. Subsequent "upstream" role changes don't affect
+an account's CodeRabbit role.
+
+## View or set roles {#how-to}
+
+You can view and set roles from the CodeRabbit dashboard, as detailed in the
+following sections.
+
+### View roles {#view-roles}
+
+To view a list of your organization's role assignments, follow these steps:
+
+1. Go to the [CodeRabbit dashboard](https://app.coderabbit.ai/settings/repositories).
+1. At the top of the sidebar, select the organization whose user roles you want to view.
+1. On the sidebar, click **Subscription**.
+
+This displays a table of all of the CodeRabbit **Admin** and **Member** accounts associated with the selected
+organization. In this table, the **Role** column displays the CodeRabbit role for
+each account.
+
+To view a list of accounts with the **Billing Admin** role, click the **Billing Admins** tab located above the table of user accounts.
+
+### Set roles {#set-roles}
+
+:::note
+To modify users' CodeRabbit accounts, your own account must have the **Admin** role within your organization.
+:::
+
+To change a user account's CodeRabbit role, follow these steps:
+
+1. Go to your organization's list of user accounts, as detailed in the previous section.
+ If you have the **Admin** role within this organization, then the **Role** column in the user accounts table contains selectable menus.
+1. Click the menu in the user's **Role** column, and select the appropriate role from
+ the list.
+
+The only roles you can assign through this method are **Admin** and **Member**.
+You can't grant the **Billing Admin** role to an existing user account. To add an account with the **Billing Admin** role, see the next section.
+
+### Add billing admin accounts {#billing}
+
+:::note
+Billing Admin users don't require CodeRabbit seat licenses. You can add Billing Admin users regardless of how many seat licenses you have available.
+:::
+
+To add a CodeRabbit user account with the **Billing Admin** role, follow these steps:
+
+1. Go to your organization's list of user accounts, as detailed in [View roles](#view-roles).
+1. Click **Invite Billing Admin**.
+1. Enter the name and email address of the billing administrator who you want to invite to the organization.
+
+This sends an email to the address that you specified. After the recipient completes the process of joining your organization in CodeRabbit, then their record appears in the user accounts list, under the **Billing Admins** tab.
+
+## Role permissions {#permissions}
+
+The following table lists the CodeRabbit administrative functionality
+available to each of the CodeRabbit roles.
+
+| Resource | Admin | Member | Billing Admin |
+| ----------------------- | ---------- | --------- | ------------- |
+| Learning Resources | Read/Write | Read-only | No access |
+| Metrics/Dashboard | Read/Write | No access | No access |
+| Reports | Read/Write | Read-only | No access |
+| Integrations | Read/Write | Read-only | No access |
+| Repository Settings | Read/Write | Read-only | No access |
+| Organization Settings | Read/Write | Read-only | No access |
+| User Management | Read/Write | Read-only | Read-only |
+| Subscription Management | Read/Write | Read-only | Read/Write |
+| Billing Management | Read/Write | No access | Read/Write |
+
+## What's next {#whats-next}
+
+- [Manage your subscription](/getting-started/subscription-management)
diff --git a/docs/guides/scheduled-reports.md b/docs/guides/scheduled-reports.md
index 02507528..34c59032 100644
--- a/docs/guides/scheduled-reports.md
+++ b/docs/guides/scheduled-reports.md
@@ -1,8 +1,6 @@
---
-title: Scheduled Reports
-sidebar_label: Scheduled Reports
+title: Schedule reports
description: Learn how to set up automated recurring reports with CodeRabbit Pro
-sidebar_position: 6
---
```mdx-code-block
@@ -13,6 +11,8 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
CodeRabbit Pro offers automated recurring reports that provide insights into your GitHub organization's activities. These reports can be customized and delivered through various channels to help teams stay informed about development progress.
+For a conceptual overview of reports in CodeRabbit, see [Generate reports](/guides/reports-overview).
+
## Setting Up a Recurring Report
1. Navigate to **Recurring Reports** in the [CodeRabbit dashboard](https://app.coderabbit.ai/reports/recurring)
@@ -129,6 +129,7 @@ Configure where your reports will be delivered:
1. Connect your workspace through OAuth
2. Select target channels
3. CodeRabbit bot will be installed automatically
+4. If installation fails check the [slack service](https://slack-status.com/) or [discord status](https://discordstatus.com/) page for any outages.
#### Microsoft Teams
@@ -142,6 +143,22 @@ Create separate reports if you need to send to multiple channels with different
## Managing Reports
+
+
### Preview Reports
Test your configuration using the **Preview Report** button to generate a sample report instantly.
@@ -233,3 +250,8 @@ Deleting a report will immediately stop all scheduled runs and remove access to
- [Custom Reports](./custom-reports.md)
- [On-demand Reports](./ondemand-reports.md)
- [API Documentation](https://api.coderabbit.ai/api/swagger/)
+
+## What's next
+
+- [Customize reports](/guides/custom-reports)
+- [Generate reports on demand](/guides/ondemand-reports)
diff --git a/docs/guides/setup-best-practices.md b/docs/guides/setup-best-practices.md
new file mode 100644
index 00000000..c6caa094
--- /dev/null
+++ b/docs/guides/setup-best-practices.md
@@ -0,0 +1,131 @@
+---
+title: "Setup and configuration best practices"
+description: Best practices for seting up CodeRabbit.
+sidebar_label: Setup and configuration
+---
+
+This page contains our best-practice advice for setting up CodeRabbit, and then
+configuring its code review behavior.
+
+## Setup best practices {#setup}
+
+This section lists our recommendations for setting up CodeRabbit with your
+Git platform, and integrating CodeRabbit with other tools and services.
+
+### Give CodeRabbit its own user account {#user}
+
+CodeRabbit works best when it has a user account all to itself on your Git platform.
+Your team treats this account as a bot or service account—even on platforms that don't
+have a formal concept of separate service accounts, such as Bitbucket Cloud.
+
+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.
+
+For platform-specific instructions about setting up this user, see
+[Integrate with Git platforms](/platforms/).
+
+### Let CodeRabbit read your issue tracker {#issues}
+
+CodeRabbit can report on whether the changes proposed by a pull request
+successfully address specific, ticketed issues referenced by that pull request.
+
+For this to work, CodeRabbit needs read access to your team's issue management system.
+
+If you use the built-in issue management of either GitHub or GitLab, then
+CodeRabbit issue integration works without any further setup.
+
+If you use issue management systems external from your Git platform, then you need to
+take additional steps to integrate CodeRabbit with your team's issues.
+
+These are the external issue management systems that CodeRabbit supports:
+
+- Jira
+- Linear
+
+For more information, see [Integrate issue tracking](/integrations/issue-integrations/).
+
+### Set up basic reports for your team {#reports}
+
+CodeRabbit has a flexible reporting feature that can help keep your whole team
+up-to-date about the latest changes to your repositories. We recommend setting
+up at least the following scheduled reports, using templates available
+through the CodeRabbit web interface:
+
+- A daily standup report, grouped by contributor.
+- Regular release notes, grouped by repository.
+
+For more information, see [Generate reports](/guides/reports-overview).
+
+## Configuration best practices {#configuration}
+
+This section lists our recommendations for configuring the way that CodeRabbit
+works with your individual repositories.
+
+### Fine-tune reviews using YAML files {#yaml}
+
+CodeRabbit gives you two ways to configure how it works with your team's repositories:
+
+- The **Organization Settings** and **Repositories** pages of [the
+ CodeRabbit web interface](https://app.coderabbit.ai/login)
+- A [`.coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository
+
+The web interface lets you set up your organization's code review
+preferences rapidly, and can help you get familiar with CodeRabbit configuration options.
+
+We recommend adding a `.coderabbit.yaml` file to repositories, as well. Using this file has several advantages over using only the web interface:
+
+- It applies version control to your repository's CodeRabbit settings, letting you track changes, view configuration history, and revert to previous configurations as needed.
+- During code reviews, CodeRabbit loads the file along with rest of your repository. This means that you can include setting changes as part of a pull request, and CodeRabbit both analyzes and applies these settings during its review.
+- The file makes the repository's CodeRabbit settings transparent to all of the repository's contributors.
+
+Repository-level settings defined by a `.coderabbit.yaml` take precedence over the
+settings defined for that repository or for your organization using the CodeRabbit web interface.
+
+For more information, see [Add a configuration file](/getting-started/configure-coderabbit/).
+
+### Speed up reviews by adding path filters {#filters}
+
+If your repository contains a lot of data or other content that CodeRabbit
+doesn't need for code review context, then you can include _path filters_ in
+your repository configuration. For example, a filter of `!dist/**` tells CodeRabbit
+to disregard everything in your repository's top-level `dist` directory when
+preparing a code review.
+
+Reducing the number of contextual files that CodeRabbit needs to read and analyze
+when preparing a code review can help make its code reviews faster.
+
+You can define path filters using the CodeRabbit
+web interface, or with [a `.coderabbit.yaml` file](/getting-started/configure-coderabbit/).
+
+### Trust the defaults {#defaults}
+
+CodeRabbit gives you control over a number of its core code-review features, letting you deactivate them entirely for your repositories if needed. We have chosen the default settings to meet the needs of most organizations and situations, and recommend leaving these settings at their default values if possible:
+
+- **Cache**: Keep [the cache](/reference/caching) enabled to let CodeRabbit temporarily remember details about your repository
+ between reviews, which improves review speed.
+- **Tools**: By default, CodeRabbit is allowed to use all of the [open-source linters and analyzer
+ tools](/tools) that are available to it during code reviews. This helps CodeRabbit keep its reviews broad and flexible.
+- **Knowledge base**: CodeRabbit [knowledge base](/integrations/knowledge-base/) features, including learnings and issue tracking, can require data retention. If your organization needs to meet stricter data-retention policies, then you can opt out of using these features.
+
+You can configure your use of the above features using the CodeRabbit web interface, or [a `.coderabbit.yaml` file](/getting-started/configure-coderabbit/).
+
+### Write specific CI/CD error messages {#pipeline}
+
+CodeRabbit can analyze the logs of continuous integration (CI) or continuous
+deployment (CD) tools in your pipeline. CodeRabbit can provide better remediation
+advice about CI/CD failures during code reviews if your tools' error messages
+are as specific as possible when reporting failures.
+
+For CodeRabbit to provide the best advice, configure your CI/CD failure output to include the following information:
+
+- File names associated with the failure.
+- Line numbers that identify where the failure occurred in those files.
+- An explanation of the failure, including relevant error codes or diffs.
+
+[This pull request](https://github.com/ff14-advanced-market-search/temp-fe/pull/47/files) shows an example of expanding the context of a CI error,
+in this case including a diff to show why a code-formatter check failed.
+
+---
+
+## What's next {#whats-next}
+
+- [Code review best practices](/guides/code-review-best-practices)
diff --git a/docs/guides/uninstall-vscode.md b/docs/guides/uninstall-vscode.md
new file mode 100644
index 00000000..27266d47
--- /dev/null
+++ b/docs/guides/uninstall-vscode.md
@@ -0,0 +1,25 @@
+---
+title: Uninstall the VSCode extension
+description: How to uninstall the CodeRabbit VSCode extension
+---
+
+This page is about uninstalling the CodeRabbit VSCode extension. For more information about the extension, see
+[Review local changes](/code-editors).
+
+:::note
+The instructions on this page are specific to using the extension with VSCode. If you are instead using a VSCode-compatible editor such as Cursor or Windsurf, then the steps that you need to follow are similar, but might require some adaptation.
+:::
+
+## Uninstall the extension
+
+To uninstall the VSCode extension, follow these steps:
+
+1. In the VSCode activity bar, click the CodeRabbit icon.
+
+1. In the CodeRabbit sidebar, click the door-shaped **Logout** icon.
+
+1. In the VSCode activity bar, click the **Extensions** icon.
+
+1. In the Extensions sidebar, click the gear-shaped **Manage** icon next to CodeRabbit in the list of installed extensions.
+
+1. Select **Uninstall**.
diff --git a/docs/guides/use-vscode.md b/docs/guides/use-vscode.md
new file mode 100644
index 00000000..169dc2a8
--- /dev/null
+++ b/docs/guides/use-vscode.md
@@ -0,0 +1,109 @@
+---
+title: Use the VSCode extension
+description: How to review your code with the VSCode extension.
+---
+
+This page is about performing local code reviews using the CodeRabbit VSCode extension. For more information about the extension, see
+[Review local changes](/code-editors). To learn how to install the extension, see [Install the VSCode extension](/guides/install-vscode).
+
+The CodeRabbit VSCode extension works by comparing changes in your current, checked-out Git branch against another branch in your local repository. You can use the extension to automatically perform full-branch changes after every commit, or make different kinds of comparisons by manually requesting a review.
+
+:::note
+The instructions on this page are specific to using the extension with VSCode. If you are instead using a VSCode-compatible editor such as Cursor or Windsurf, then the steps that you need to follow are similar, but might require some adaptation.
+:::
+
+## Automatically review local commits {#auto-reviews}
+
+You can let CodeRabbit automatically review commits that you make to your local Git repository. These automatic reviews compare all committed changes against the branch that your working branch is based on.
+
+To perform an automatic review, follow these steps:
+
+1. Perform a Git commit using VSCode or terminal. After you do this, a dialog appears in your VSCode window, asking **Would you like to start a review?**
+
+1. Click **Yes**. The CodeRabbit sidebar appears in your VSCode window.
+
+1. Wait for the review to complete. This might take a few minutes. To cancel a review in progress, click **Stop the review**.
+
+After the review completes, you can browse and respond to review comments as described in [Work with code reviews](#work).
+
+You can optionally configure the extension to either always or never perform automatic code reviews on commit, instead of displaying this yes-or-no dialog. For more information, see [Configure automatic review behavior](/guides/config-vscode#auto-reviews).
+
+For more control of code reviews performed using the CodeRabbit VSCode extension, you can manually request a review, as detailed in the following section.
+
+## Manually request code reviews {#manual-reviews}
+
+To manually review changes in a local Git branch using the CodeRabbit VSCode extension, follow these steps:
+
+1. Click the CodeRabbit icon in the VSCode activity bar. The CodeRabbit sidebar appears.
+
+1. If you want to compare your code changes to a branch other than its base branch, then follow these steps:
+
+ 1. In the sidebar, under **Branch**, click the name of the base branch. A **Select a base branch** dialog appears, listing other branches in your local Git repository.
+
+ 1. Select the name of a base branch to compare against.
+
+1. Select one of the review-action options from the menu at the bottom of the CodeRabbit sidebar:
+
+ - To review all changes between the base branch and your current branch, including both committed and uncommitted changes, select **Review all changes**. This is the default selection.
+
+ - To limit the review to only changes on your branch that you have committed, select **Review committed changes**. This includes commits that you have pushed to your remote repository, if any, as well as any local commits.
+
+ - To limit the review to only uncommitted changes on your branch, select **Review uncommitted changes**. This includes both staged and unstaged changes.
+
+1. Refer to the list of **Files to review** in the sidebar. This list represents all of the files that the selected review action includes. To change this list of files, repeat the previous step to choose a different review action, or use Git features like `git stash` to selectively remove changes.
+
+1. To perform the review, click the button part of the menu. The CodeRabbit sidebar displays a **Review** section with the review's progress.
+
+1. Wait for the review to complete. This might take a few minutes. To cancel a review in progress, click **Stop the review**.
+
+After the review completes, you can browse and respond to review comments as described in the following section.
+
+## Work with code reviews {#work}
+
+The CodeRabbit VSCode extension presents code reviews as a series of actionable comments, connected to specific files and lines. It gives you tools to apply its suggestions quickly, when possible.
+
+### Browse comments {#browse}
+
+After the extension finishes its review, it adds any comments to the CodeRabbit sidebar under the **Files** heading in the **Reviews** section.
+
+Each item in **Files** is a comment referring to one or more lines in that file. Click the comment to see a detailed, inline comment in the editor, attached to the appropriate file and lines.
+
+You can react to these comments however you want: you can apply their advice literally, or let them guide you to find alternate solutions, or ignore them entirely. CodeRabbit comments are metadata stored with VSCode, and are not part of your files. The presence of comments doesn't block your use of version control.
+
+### Apply suggested changes {#apply}
+
+Whenever possible, the CodeRabbit VSCode extension attaches discrete change suggestion to comments in the form of code diffs. For example, if it detects a typo in a new function name, the extension might attach a diff with a suggested correction.
+
+If you agree with CodeRabbit about the suggested fix and want to apply to exactly as it proposes, click the checkmark-shaped **Apply suggested change** icon in the inline comment. The extension makes the change for you in the editor.
+
+### Request help from your AI coding agent {#agent}
+
+If CodeRabbit determines that an AI coding agent could help with resolving one of its comments, then it adds a star-shaped **Fix with AI** icon to the inline display of that comment. To have the extension generate a request for an AI agent to address the comment, click this icon.
+
+Depending upon your IDE and the current extension settings, the extension performs one of the following actions:
+
+- If you are using VSCode with Copilot installed, then the extension can send the request directly to Copilot.
+- If you have Claude Code installed, then the extension can send the request to the `claude` command-line program.
+- As a fallback, the extension can copy the request, phrased as an AI prompt, to your clipboard. You can then manually paste this prompt into the coding AI of your IDE.
+
+For more information about configuring this behavior, see [Configure AI agent integration](/guides/config-vscode#agent).
+
+### Ignore or collapse comments {#ignore}
+
+To remove a comment from the editor, click its **Ignore** icon.
+
+To remove a comment but keep an icon in the editor noting its presence, click its **Collapse** icon.
+
+To see an ignored or collapsed comment in the editor again, click its summary in the CodeRabbit sidebar.
+
+### Browse previous reviews {#previous}
+
+If you have performed reviews prior to the most recent review in the current VSCode window, then you can browse the comments from these reviews under the **Previous reviews** heading in the CodeRabbit sidebar.
+
+If a past review comment no longer applies to the current state of your code, then clicking that comment won't display a detailed comment or suggestion in the editor.
+
+## What's next {#whats-next}
+
+- [Configure the VSCode extension](/guides/config-vscode)
+
+- [Uninstall the VSCode extension](/guides/uninstall-vscode)
diff --git a/docs/integrations/code-graph-analysis.md b/docs/integrations/code-graph-analysis.md
new file mode 100644
index 00000000..5958640a
--- /dev/null
+++ b/docs/integrations/code-graph-analysis.md
@@ -0,0 +1,64 @@
+---
+title: Analyze your code changes
+description: Learn about CodeRabbit's intelligent graph-based code analysis.
+---
+
+# CodeRabbit Code Graph Analysis
+
+## What is Code Graph Analysis?
+
+Code Graph Analysis is an intelligent code analysis feature that enhances your code reviews by automatically mapping relationships between files in your codebase. By
+understanding how your code connects and interacts, Code Graph provides concrete snippets of context that makes reviews more effective and insightful.
+
+## How Code Graph Analysis Enhances Your Reviews
+
+When reviewing code with CodeRabbit, Code Graph Analysis automatically:
+
+- **Maps symbol definitions and references** across your entire codebase
+- **Analyzes commit history** to identify files that frequently change together
+- **Builds relationship graphs** showing how different parts of your code connect
+- **Enriches reviews with contextual information** about related code
+
+Code Graph Analysis is also available in the CodeRabbit Chat. CodeRabbit Chat will automatically analyze your codebase with it when the agent deems it necessary.
+
+## Key Features
+
+### Three Types of Contextual Information
+
+Code Graph Analysis adds three powerful layers of context to your reviews:
+
+1. **Definition Files**: Files containing definitions that are referenced in the current code
+2. **Reference Files**: Files that reference symbols defined in the current code
+3. **Related Files**: Files that appear related based on usage patterns and commit history
+
+### Language Support
+
+Code Graph Analysis works with:
+
+- Bash
+- C
+- C#
+- C++
+- CSS
+- Elixir
+- Go
+- Java
+- JavaScript
+- Kotlin
+- Lua
+- PHP
+- Python
+- Ruby
+- Rust
+- Scala
+- Swift
+- TSX
+- TypeScript
+
+## Availability
+
+Code Graph Analysis is available on the Lite tier and above.
+
+---
+
+Learn more about CodeRabbit's advanced features at [coderabbit.ai](https://coderabbit.ai)
diff --git a/docs/integrations/issue-integrations.md b/docs/integrations/issue-integrations.md
index 11562df3..0ad69f54 100644
--- a/docs/integrations/issue-integrations.md
+++ b/docs/integrations/issue-integrations.md
@@ -1,8 +1,6 @@
---
-title: Issue Integrations
+title: Integrate issue tracking
description: Learn about CodeRabbit's integrations with issue tracking systems like Jira and Linear.
-sidebar_label: Issue Integrations
-sidebar_position: 5
---
CodeRabbit integrates with popular issue tracking systems to provide context from linked and related issues while reviewing code.
@@ -37,12 +35,16 @@ To link a Jira Issue, you can add the Jira Issue into the PR description as show
Closes CR-5
```
+You can also create new Jira issues directly through CodeRabbit. See our [Issue Creation guide](../guides/issue-creation.md#jira) for details.
+
## Linear {#Linear}
```mdx-code-block
+
+
+
+### Java Build & Testing
+
+- Maven/Gradle dependency conflicts
+- Compilation errors
+- Test failures
+- Memory allocation issues
+
+
+
+### Kubernetes Deployments
+
+- Service configuration validation
+- Resource allocation optimization
+- Network policy fixes
+- Security context remediation
+
+
+
+### NPM Package Management
+
+- Package resolution conflicts
+- Version compatibility issues
+- Security vulnerability patches
+- Build script optimization
+
+
+
+### Python Environment
+
+- Package dependency resolution
+- Virtual environment setup
+- Test framework configuration
+- Code style compliance
+
+
+
+### Security Scanning
+
+- SAST finding remediation
+- Code injection prevention
+- Security best practices
+- Compliance validation
+
+
+
+### Terraform and Infrastructure as Code
+
+- Resource configuration validation
+- State management issues
+- Provider compatibility
+- Security group optimization
+
+
+
+## Supported Platforms
+
+### GitHub Actions
+
+- Automatic detection of workflow failures
+- Inline fixes for common build issues
+- Integration with GitHub Checks
+- Support for custom actions and workflows
+
+### GitLab CI/CD
+
+- GitLab CI/CD Pipeline failure analysis
+- Integration with GitLab Advanced Security
+- Support for DAST (Dynamic Application Security Testing) findings
+- Remediation for SAST (Static Application Security Testing) issues
+
+
+
+
+
+### CircleCI
+
+- CircleCI Pipeline failure analysis
+- Job-level error analysis
+- Configuration validation
+- Dependency resolution
+
+
+
+### Azure DevOps Pipelines
+
+- Azure DevOps CI/CD Pipeline failure analysis
+- Integration with Azure DevOps Checks
+- Support for custom tasks and pipelines
+- Remediation for build issues
+
+
+
+## Common Use Cases
+
+Our tool handles a wide range of pipeline failures including:
+
+### Build Failures
+
+- Docker build issues
+- Node.js dependency conflicts
+- Java compilation errors
+- Python package resolution
+- Go module management
+
+### Infrastructure as Code
+
+- Kubernetes manifest validation
+- Terraform template errors
+- CloudFormation stack issues
+- Ansible playbook failures
+
+### Security Pipeline Integration
+
+- SAST finding remediation
+- DAST vulnerability fixes
+- Dependency scanning
+- Container security
+
+### Testing Failures
+
+- Unit test failures
+- Integration test errors
+- End-to-end test issues
+- Performance test threshold violations
+
+## How It Works
+
+1. **Detection**: CodeRabbit monitors your pipeline runs and automatically detects failures
+2. **Analysis**: Our AI analyzes the failure logs and context to determine the root cause
+3. **Remediation**: We provide inline suggestions and automated fixes where possible
+4. **Learning**: The system learns from successful fixes to improve future recommendations
+
+## Best Practices
+
+1. **Keep Dependencies Updated**: Regular dependency updates help prevent build failures
+2. **Use Lock Files**: Lock files ensure consistent builds across environments
+3. **Implement Caching**: Proper caching strategies speed up builds and reduce failures
+4. **Monitor Resource Usage**: Ensure sufficient resources are allocated to prevent timeouts
+5. **Maintain Clean Tests**: Well-maintained tests reduce false positives
+
+## Links
+
+- [GitHub Actions Configuration](https://docs.github.com/en/actions)
+- [GitLab CI/CD Documentation](https://docs.gitlab.com/ee/ci/)
+- [CircleCI Documentation](https://circleci.com/docs/)
+- [Azure DevOps Pipeline Documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/get-started/pipelines-get-started?view=azure-devops)
diff --git a/docs/tools/prisma-lint.md b/docs/tools/prisma-lint.md
new file mode 100644
index 00000000..33a36904
--- /dev/null
+++ b/docs/tools/prisma-lint.md
@@ -0,0 +1,46 @@
+---
+title: Prisma Lint
+sidebar_label: Prisma Lint
+description: CodeRabbit's guide to Prisma Lint.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+