Skip to content

Commit aed9bcc

Browse files
alexcoderabbitaialexcoderabbitai
authored
Merge branch 'main' into quickstart
2 parents 42785f8 + b18416a commit aed9bcc

17 files changed

+1868
-33
lines changed

Diff for: ‎.github/workflows/node.js.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ jobs:
2626
cache: pnpm
2727
- run: pnpm install --frozen-lockfile --strict-peer-dependencies
2828
- run: pnpm run build
29+
env:
30+
API_KEY: ${{ secrets.INKEEP_API_KEY }}
2931
- run: pnpm run lint
3032

3133
fix:

Diff for: ‎docs/changelog.md

+36-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,41 @@ description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 13
66
---
77

8+
## April 14, 2025
9+
10+
### Shopify CLI Integration & Bitbucket Cloud Reporting
11+
12+
We're excited to announce two significant updates:
13+
14+
#### Shopify CLI Integration
15+
16+
We've added support for [Shopify CLI](https://docs.coderabbit.ai/tools/shopify-cli), a powerful tool for validating and analyzing Shopify themes and apps. This integration helps ensure your Shopify projects follow best practices by:
17+
18+
- Validating Liquid syntax and theme requirements
19+
- Checking app extension configurations
20+
- Identifying performance bottlenecks
21+
- Ensuring accessibility standards
22+
- Detecting security vulnerabilities
23+
24+
#### Bitbucket Cloud Scheduled Reporting
25+
26+
Our reporting capabilities now extend to Bitbucket Cloud! You can now:
27+
28+
- Schedule automated reports for your Bitbucket Cloud repositories
29+
- Generate customized summaries of team performance
30+
- Track PR review metrics
31+
- Deliver reports via Email, Slack, Microsoft Teams, or Discord
32+
33+
## April 11 2025
34+
35+
### Agent Chat
36+
37+
```mdx-code-block
38+
<ProPlanNotice />
39+
```
40+
41+
We're thrilled to introduce agentic planning on GitHub for CodeRabbit chat as Generally Available for Pro users. This enhancement lets you make more advanced requests that span multiple files. Just add a review or issue comment on any pull request, or issue comment on an issue, issue tagging `@coderabbitai` along with your natural language request for a code change, and the chat will develop a plan for complex modifications. Upon reviewing the plan and getting your consent, CodeRabbit will emit a stacked PR, commit or copyable snippet to your PR or issue for those code changes.
42+
843
## April 8, 2025
944

1045
### New Static Analysis Tools
@@ -29,7 +64,7 @@ In the review status message. It is automatically enabled for all users.
2964

3065
### Automatically Run a Web Query to Include Latest Information
3166

32-
CodeRabbit now performs Web Queries automatically to include the most recent publicly available information — even if it wasn’t included in the latest LLM update. This feature is enabled by default for all users, and you may notice it being used in review comments and chat responses.
67+
CodeRabbit now performs Web Queries automatically to include the most recent publicly available information — even if it wasn't included in the latest LLM update. This feature is enabled by default for all users, and you may notice it being used in review comments and chat responses.
3368

3469
Web Queries allow CodeRabbit to fetch the latest documentation and external content to improve the accuracy and relevance of its output. You can disable this feature by setting web_search: false in your knowledge_base settings.
3570

Diff for: ‎docs/guides/agent_chat.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Agent chat can be invoked explicitly with the `@coderabbitai plan` command.
6565

6666
CodeRabbit cannot perform further modifications to opened pull requests. From there, it's your turn to checkout the branch and improve it to satisfaction. We believe that this workflow provides a significant headstart to implementing code.
6767

68-
Agentic Chat is currently only available on Github issue, pull request and pull request review comments. Agentic Chat is an early access product currently.
68+
Agentic Chat is currently only available on Github issue, pull request and pull request review comments.
6969

7070
### Help and Feedback
7171

Diff for: ‎docs/platforms/azure-devops.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ you will need to add the Personal Access Token.
7070
management.
7171
- **Use the CodeRabbit logo as the profile picture** - This further ensures easy
7272
recognition. You can download our logo from
73-
[here](/img/integrations/logo.svg "download").
73+
[here](/img/integrations/logo.png "download").
7474

7575
### Key Points to Remember
7676

Diff for: ‎docs/platforms/github-enterprise-server.md

+2
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,8 @@ Keep the following details handy:
130130

131131
![GitHub App Client ID & Secret](/img/integrations/github-app-client-id-secret.png)
132132

133+
We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
134+
133135
### **Step 4: CodeRabbit UI Onboarding**
134136

135137
Submit the details that were accumulated in previous steps:

Diff for: ‎docs/platforms/self-hosted-gitlab.md

+2
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ After the user is created, you can retrieve the **User ID** from that user's
7171
profile and generate an [**access token**](#generating-personal-access-token).
7272
The access token is used to post reviews on merge requests.
7373

74+
We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
75+
7476
#### **Creating OAuth2 application**
7577

7678
For self-managed GitLab, we recommend creating an instance-wide application

Diff for: ‎docs/self-hosted/azure-devops.md

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ The self-hosted option is only available for CodeRabbit Enterprise customers wit
1616
- **Username**: Set the username to "CodeRabbit" for easier identification (optional).
1717
- **Profile Image**: Use the CodeRabbitAI logo for the user image (optional).
1818

19+
We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
20+
1921
## Add User to Projects
2022

2123
Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with rights to post reviews & open PRs.

Diff for: ‎docs/self-hosted/bitbucket.md

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ The self-hosted option is only available for CodeRabbit Enterprise customers wit
1616
- **Username**: Set the username to "CodeRabbit" for easier identification (optional).
1717
- **Profile Image**: Use the CodeRabbitAI logo for the user image (optional).
1818

19+
We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
20+
1921
## Add User to Projects
2022

2123
Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with permissions to:

Diff for: ‎docs/self-hosted/github.md

+2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ Set the following events:
4242
- Push
4343
- Release
4444

45+
We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
46+
4547
## Gather information from the GitHub App
4648

4749
- App ID

Diff for: ‎docs/self-hosted/gitlab.md

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ The self-hosted option is only available for CodeRabbit Enterprise customers wit
1616
- **Username**: Set the username to "CodeRabbit" for easier identification (optional).
1717
- **Profile Image**: Use the CodeRabbitAI logo for the user image (optional).
1818

19+
We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
20+
1921
## Add User to Projects
2022

2123
Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with at least `Developer` access.

Diff for: ‎docs/tools/shopify-cli.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Shopify CLI
3+
sidebar_label: Shopify CLI
4+
description: CodeRabbit's guide to Shopify CLI.
5+
---
6+
7+
```mdx-code-block
8+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
9+
10+
<ProPlanNotice />
11+
```
12+
13+
[Shopify CLI](https://github.com/Shopify/cli) is a command-line tool that helps you build Shopify apps, themes, and custom storefronts. It provides functionality for initializing, building, developing, and deploying Shopify projects.
14+
15+
## Validation Rules
16+
17+
The tool checks for:
18+
19+
### Theme Validation
20+
21+
- Liquid syntax errors
22+
- Theme requirements compliance
23+
- Asset organization
24+
- Performance best practices
25+
- Accessibility standards
26+
27+
### App Validation
28+
29+
- App extension configuration
30+
- Function implementation
31+
- API version compatibility
32+
- Security best practices
33+
34+
## Common Issues
35+
36+
The tool helps identify and fix:
37+
38+
1. Theme Issues:
39+
40+
- Invalid Liquid syntax
41+
- Missing required templates
42+
- Performance bottlenecks
43+
- Accessibility violations
44+
45+
2. App Issues:
46+
- Invalid API usage
47+
- Missing dependencies
48+
- Configuration errors
49+
- Security vulnerabilities
50+
51+
## Links
52+
53+
- [Shopify CLI GitHub Repository](https://github.com/Shopify/cli)
54+
- [Shopify CLI Theme Documentation](https://shopify.dev/docs/api/shopify-cli/theme)
55+
- [Shopify CLI App Documentation](https://shopify.dev/docs/apps/tools/cli)
56+
- [Theme Development Requirements](https://shopify.dev/docs/themes/store/requirements)

Diff for: ‎docs/tools/tools.md

+2
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Remove extraneous f prefix
7070
| Ruby | [RuboCop][RuboCop] | Code Quality |
7171
| Semgrep | [Semgrep][Semgrep] | Code Security |
7272
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality |
73+
| Shopify | [Shopify CLI][ShopifyCLI] | Code Quality |
7374
| SQL | [SQLFluff][SQLFluff] | Code Quality |
7475
| Swift | [SwiftLint][SwiftLint] | Code Quality |
7576
| Terraform | [Checkov][Checkov] | Code Security |
@@ -103,3 +104,4 @@ Remove extraneous f prefix
103104
[Pipeline]: ./pipeline-remediation.md
104105
[PrismaLint]: ./prisma-lint.md
105106
[OXC]: ./oxc.md
107+
[ShopifyCLI]: ./shopify-cli.md

Diff for: ‎docusaurus.config.ts

+42
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,48 @@ const config: Config = {
126126
},
127127
}
128128
},
129+
[
130+
"@inkeep/cxkit-docusaurus",
131+
{
132+
SearchBar: {
133+
baseSettings: {
134+
apiKey: process.env.INKEEP_API_KEY,
135+
primaryBrandColor: "#FF570A",
136+
},
137+
aiChatSettings: {
138+
chatSubjectName: "CodeRabbit",
139+
aiAssistantAvatar: "https://www.coderabbit.ai/favicon.ico",
140+
getHelpOptions: [
141+
{
142+
name: "Discord",
143+
icon: {
144+
builtIn: "FaDiscord",
145+
},
146+
action: {
147+
type: "open_link",
148+
url: "https://discord.gg/coderabbit",
149+
},
150+
},
151+
{
152+
name: "Contact Us",
153+
icon: {
154+
builtIn: "IoChatbubblesOutline",
155+
},
156+
action: {
157+
type: "open_link",
158+
url: "https://www.coderabbit.ai/contact-us",
159+
},
160+
},
161+
],
162+
exampleQuestions: [
163+
"What is CodeRabbit?",
164+
"How to integrate CodeRabbit with GitHub?",
165+
"How to set up a AI Code Review?",
166+
],
167+
},
168+
},
169+
},
170+
],
129171
],
130172

131173
presets: [

Diff for: ‎package.json

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
"@docusaurus/plugin-client-redirects": "^3.6.1",
2424
"@docusaurus/plugin-content-blog": "^3.6.1",
2525
"@docusaurus/preset-classic": "^3.6.1",
26+
"@inkeep/cxkit-docusaurus": "^0.5.52",
2627
"@mdx-js/react": "^3.1.0",
2728
"autoprefixer": "^10.4.20",
2829
"clsx": "^2.1.1",

0 commit comments

Comments
 (0)