8000 Update changelog.md · coderabbitai/coderabbit-docs@d87b1b4 · GitHub
[go: up one dir, main page]
Skip to content

Commit d87b1b4

Browse files
MonRay2024MonRay2024
authored
Update changelog.md
1 parent 7c9dba6 commit d87b1b4

File tree

1 file changed

+118
-104
lines changed

1 file changed

+118
-104
lines changed

‎docs/changelog.md

Lines changed: 118 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,55 @@ description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 9
66
---
77

8-
## Microsoft Teams Stand Up Reporting
9-
#### Oct 30, 2024
8+
## October 30, 2024
9+
### Microsoft Teams Integration & Bitbucket Support
1010

11-
- Added support for Stand-up scheduled reporting features for Microsoft Teams over webhooks
12-
## Security and SAST Remediation Improvements
13-
#### Oct 22, 2024
14-
- Enabling comprehensive security analysis directly from context within GitHub Checks.
11+
Our integration capabilities just got a major upgrade with Microsoft Teams and Bitbucket support.
12+
13+
- Microsoft Teams integration is with scheduled reporting system and direct notification pipeline to keep your team informed.
14+
15+
- We've also launched Bitbucket Data Center support with Pull Request integration, offering core review functionality, Pull Request summaries, and direct inline comments for applying review suggestions
16+
17+
18+
19+
## October 22, 2024
20+
### Security and SAST Remediation Improvements
21+
22+
- Enabling comprehensive security analysis directly from context within GitHub Checks
1523
- CodeRabbit now seamlessly integrates with top SAST tools that create github check annotation comments like Codacy, SonarCloud, Code Climate, GitHub Advanced Security, Palo Alto Prisma Cloud, and more!
16-
- We have added a [YouTube Tutorial](https://www.youtube.com/watch?v=tfy3FdsoUtU) for a step-by-step guide on using CodeRabbit with Codacy and SonarCloud during pull requests.
17-
- Improved the [Semgrep Documentation](https://docs.coderabbit.ai/tools/semgrep).
18-
- CodeRabbit now automatically detects Semgrep rulesets from default `semgrep.yml` or `semgrep.config.yml` files, eliminating the need for manual configuration.
24+
- We have added a [YouTube Tutorial](https://www.youtube.com/watch?v=tfy3FdsoUtU) for a step-by-step guide on using CodeRabbit with Codacy and SonarCloud during pull requests
25+
- Improved the [Semgrep Documentation](https://docs.coderabbit.ai/tools/semgrep)
26+
- CodeRabbit now automatically detects Semgrep rulesets from default `semgrep.yml` or `semgrep.config.yml` files, eliminating the need for manual configuration
1927

28+
## September 9, 2024
29+
### Related PRs and Label suggestions
2030

21-
## Related PRs and Label suggestions
22-
#### Sep 9, 2024
23-
- Possibly related PRs: The walkthrough comment now includes a list of potentially related PRs to help you recall the past context.
24-
- Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.
31+
- Possibly related PRs: The walkthrough comment now includes a list of potentially related PRs to help you recall the past context
32+
- Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file
2533

26-
:::note
27-
Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).
28-
:::
34+
> Note: Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).
2935
30-
## New Dashboard
31-
#### Aug 15, 2024
36+
## August 15, 2024
37+
### New Dashboard
3238

33-
We’re excited to share our updated dashboard, designed to give you better insights into CodeRabbit review metrics.
39+
We're excited to share our updated dashboard, designed to give you better insights into CodeRabbit review metrics.
3440

3541
What's new:
36-
37-
- Flexible Time Selector: Choose different periods to analyze your data.
38-
- Useful Context: See how learnings, tools, and path instructions are used in reviews.
39-
- New Visuals: Check out the bar, line, and stats charts for a better understanding.
40-
- Custom Filters: Easily filter data by user, repository, pull request, and review profile.
41-
- Tools Overview: See tool usage based on severity and total incidents reported.
42+
- Flexible Time Selector: Choose different periods to analyze your data
43+
- Useful Context: See how learnings, tools, and path instructions are used in reviews
44+
- New Visuals: Check out the bar, line, and stats charts for a better understanding
45+
- Custom Filters: Easily filter data by user, repository, pull request, and review profile
46+
- Tools Overview: See tool usage based on severity and total incidents reported
4247

4348
These updates are here to help you get more from the dashboard. Take a look today!
4449

45-
## Promote members to admin
46-
#### Jul 31, 2024
47-
You can now promote members in your organization to admins within CodeRabbit. Admins will be able to manage the subscription and the seats for that organization
50+
## July 31, 2024
51+
### Promote members to admin
4852

49-
## New Features and Improvements
50-
#### Jul 16, 2024
53+
You can now promote members in your organization to admins within CodeRabbit. Admins will be able to manage the subscription and the seats for that organization.
54+
55+
## July 16, 2024
56+
### New Features and Improvements
5157

5258
#### Learnings Page
5359

@@ -56,7 +62,6 @@ We're thrilled to announce the new "Learnings" page! Users can now interact with
5662
#### Reports (Beta) Page
5763

5864
Introducing the beta release of "Reports"! Generate recurring summaries of team performance and PR reviews with features like:
59-
6065
- Scheduling regular report generation
6166
- Specifying parameters such as repository, team, user, or label
6267
- Selecting report types (Daily Stand-Up, Sprint Report, Release Notes, Custom)
@@ -69,7 +74,6 @@ You can now choose whether to auto-generate sequence diagrams in PR Walkthroughs
6974
#### Enhanced Tool Settings & New Analysis Tools
7075

7176
We've refined the default settings to be less noisy and more actionable. Additionally, we've added new static analysis and security tools:
72-
7377
- Yamllint A linter for YAML files
7478
- Gitleaks A lightweight, open-source secret scanner to prevent security breaches
7579
- Checkov Scans infrastructure as code for misconfigurations before they become security issues
@@ -78,130 +82,144 @@ We've refined the default settings to be less noisy and more actionable. Additio
7882

7983
The GitLab integration now offers more flexibility and security. Users can use Personal Access Tokens (PATs) from within their organization to post reviews. This enhancement ensures reviews are posted with appropriate organizational context and permissions, improving traceability and security.
8084

81-
## New Features and Improvements
82-
#### May 28, 2024
83-
Sequence Diagrams
85+
## May 28, 2024
86+
### New Features and Improvements
87+
88+
#### Sequence Diagrams
8489
CodeRabbit now generates sequence diagrams of code changes, enhancing reviewers' ability to understand the flow of control.
85-
Auto-Generate PR Titles
90+
91+
#### Auto-Generate PR Titles
8692
Users will now find a new option called auto_title_placeholder and will default to `@coderabbitai` title. This option allows users to put a placeholder title and have CodeRabbit auto-generate one for them when the review process kicks in.
87-
New Commands
93+
94+
#### New Commands
8895
We have introduced new commands for interacting with CodeRabbit, detailed under the "Tips" section of a review walkthrough:
96+
- `@coderabbitai full review`: Conducts a full review from scratch, covering all files again
97+
- `@coderabbitai summary`: Regenerates the summary of the PR
98+
- `@coderabbitai configuration`: Displays the current CodeRabbit configuration for the repository
8999

90-
- `@coderabbitai full review`: Conducts a full review from scratch, covering all files again.
91-
- `@coderabbitai summary`: Regenerates the summary of the PR.
92-
- `@coderabbitai configuration`: Displays the current CodeRabbit configuration for the repository.
93-
Improved Handling of Closed PRs
100+
#### Improved Handling of Closed PRs
94101
We have been observing that many PRs get closed quickly and CodeRabbit continues to review them. PRs get closed quickly for various reasons - changes are too small, the author is confident (perhaps, overly?), or the changes were unnecessary. With this improvement, we now stop the review process midway if we detect that the PR has been closed.
95102

96-
## New Features and Improvements
97-
#### May 23, 2024
103+
## May 23, 2024
104+
### New Features and Improvements
98105

99-
Review Settings Introduced new personality profiles for code reviews
106+
#### Review Settings
100107
Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.
101-
More Static Analysis Support
108+
109+
#### More Static Analysis Support
102110
We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.
103-
Tone Settings
104-
Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:
105111

112+
#### Tone Settings
113+
Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:
106114
- Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
107115
- Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
108116
- Snarky Ex-Girlfriend: "You must talk like a snarky ex-girlfriend in all your code reviews. You're welcome."
109-
Revamped Settings Page
117+
118+
#### Revamped Settings Page
110119
We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long-time coming; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.
111120

112-
## CodeRabbit now runs Static Analyzers and Linters as part of the pull request review
113-
#### Apr 18, 2024
121+
## April 18, 2024
122+
### Static Analyzers and Linters Integration
123+
114124
CodeRabbit now runs static analyzers, linters and provides one-click fixes for the issues identified. AI helps reduce the false positives and focus on the critical findings. CodeRabbit will respect the existing configuration files of these tools if they already exist in the project. For example, if your project already uses ruff and has a ruff.toml file at the root of the project, that will be used. In cases where project configurations are not found, CodeRabbit defaults will be used. Currently, CodeRabbit runs markdownlint, shellcheck, ruff, and languagetool. We will continue to add more tools. The default configuration can be changed through the .coderabbit.yaml file.
125+
115126
Are there any specific tools you'd like us to add? Let us know. We'd love to hear your suggestions!
116127

117-
## CodeRabbit is GDPR compliant
118-
#### Apr 1, 2024
128+
## April 1, 2024
129+
### GDPR Compliance
130+
119131
Excited to announce that CodeRabbit is now GDPR compliant in accordance with EU regulations!
120132

121-
## CodeRabbit now offers fixes for GitHub Check failures on pull requests
122-
#### Mar 12, 2024
133+
## March 12, 2024
134+
### GitHub Check Fixes
135+
123136
CodeRabbit now offers fixes for GitHub Check failures on pull requests. With this change, Check Runs on GitHub that add Annotations to Pull Requests will be used. For example, popular GitHub Actions published by reviewdog (action-golangci-lint, action-staticcheck, action-eslint) and super-linter among many others have the ability to report issues on Pull Requests as annotations. Checks that output logs will be supported shortly. CodeRabbit GitHub App requires permission to read Checks for this feature to work. To enable this, please grant the necessary permissions by visiting the CodeRabbit GitHub app settings under [installation](https://github.com/settings/installations). Support for GitLab will follow.
124137

125-
## CodeRabbit is now SOC 2 Type II compliant
126-
#### Mar 11, 2024
138+
## March 11, 2024
139+
### SOC 2 Type II Compliance
140+
127141
Excited to announce that CodeRabbit is now GDPR compliant in accordance with EU regulations!
128142

129-
## Enhanced review of the markdown changes
130-
#### Mar 2, 2024
143+
## March 2, 2024
144+
### Enhanced Markdown Review
131145

132146
CodeRabbit now offers a more comprehensive review of the markdown changes. In addition to the AI suggestions, we do a thorough check for spelling, grammar, word choice, language style, as well as improvements in paraphrasing and punctuation.
133147

134-
## Integration with self-hosted GitLab is now available
135-
#### Jan 17, 2024
148+
## January 17, 2024
149+
### Self-hosted GitLab Integration
150+
136151
CodeRabbit now offers integration for self-hosted GitLab. Refer to the [setup instructions](https://docs.coderabbit.ai/integrations/self-hosted-gitlab).
137152

138-
## Deep Insights feature is out of beta
139-
#### Jan 2, 2024
153+
## January 2, 2024
154+
### Deep Insights Feature Release
155+
140156
Working as recursive autonomous agent, CodeRabbit uses shell scripts to perform complex operations on the entire codebase, verifying changes and providing deeper insights.
141-
Here are some uses cases :
142157

143-
- Want to defer implementing the CodeRabbit suggestion to a later time? Ask the bot the create an issue.
158+
Here are some uses cases:
159+
- Want to defer implementing the CodeRabbit suggestion to a later time? Ask the bot the create an issue
144160
- Generate unit tests - comment `@coderabbitai generate unit tests` for the src/utils.ts
145161
- In PR comments, ask the bot to gather insights on your repository including latest commits, frequently changed files, recent contributors etc
146-
- When the CodeRabbit review comment is addressed, let the bot know and it can validate with the latest commit.
162+
- When the CodeRabbit review comment is addressed, let the bot know and it can validate with the latest commit
163+
147164
Really excited to see how this feature gets used, especially with access to the CLI commands. There are some suggestions in the pull request tips but we are looking forward to seeing additional use cases of how developers use this feature. Please consider sharing your experiences.
148165

149-
## Request Changes Workflow
150-
#### Dec 18, 2023
166+
## December 18, 2023
167+
### Request Changes Workflow
168+
151169
Enable Request Changes review workflow for CodeRabbit reviews via .coderabbit.yaml Yaml field request_changes_workflow (default: false). When enabled, review comments are posted as request changes and CodeRabbit review will be marked approved once all the review comments are resolved.
152170

153-
## Learnings
154-
#### Dec 5, 2023
171+
## December 5, 2023
172+
### Multiple Features Release
173+
174+
#### Learnings
155175
CodeRabbit can now learn from your conversations to fine-tune your reviews. If you encounter inaccurate feedback or something not relevant to your codebase, just let the bot know, and it will remember the context for the future. We understand that coding practices and standards evolve over time. Using the chat, you can inform the bot, and it will remove any existing learnings that are no longer relevant. This feature does not work, if you have opted out of data storage.
156176

157-
## Codebase Verification
158-
#### Dec 5, 2023
177+
#### Codebase Verification
159178
Verifies the reference of the changes on the overall codebase and identifies missing changes.
160179

161-
## Jira and Linear Integrations
162-
#### Dec 5, 2023
180+
#### Jira and Linear Integrations
163181
You can now integrate Jira and Linear into CodeRabbit. This would be used for additional context while reviewing pull requests. If you use any of these systems, we recommend you integrate CodeRabbit. We will be adding more integrations over time.
164182

165-
## Related Issues
166-
#### Dec 5, 20233
167-
183+
#### Related Issues
168184
Identifies all issues affected by the code changes. This helps understand the impact on the overall product. It also assists in identifying duplicate issues or the impact on any other existing issues. This feature does not work, if you have opted out of data.
169185

170-
## Issue Validation
171-
#### Nov 5, 2023
186+
## November 5, 2023
187+
### Issue Validation
188+
172189
CodeRabbit review can now assess the pull request changes against the linked GitHub or GitLab issue. Integration with other workflow systems including Jira and Linear is under development.
173190

174-
## Committable suggestions
175-
#### Nov 1, 2023
191+
## November 1, 2023
192+
### Committable Suggestions
193+
176194
Review comments can now post committable suggestions that can be committed within the pull request with a single click.
177195

178-
## Resolve Command
179-
#### Oct 28, 2023
196+
## October 28, 2023
197+
### Resolve Command
198+
180199
Use `@coderabbitai resolve` to mark all the CodeRabbit review comments as resolved all at once.
181200

182-
## CodeRabbit Commands
183-
#### Oct 23, 2023
184-
Introducing additional CodeRabbit commands for managing code reviews.
201+
## October 23, 2023
202+
### CodeRabbit Commands
203+
204+
Introducing additional CodeRabbit commands for managing code reviews:
205+
- Pause Reviews: Use `@coderabbitai pause` in a PR comment to halt ongoing reviews
206+
- Resume Reviews: Enter `@coderabbitai resume` in a PR comment to continue paused reviews
207+
- On-Demand Reviews: Disable automatic reviews for your repository to switch to on-demand reviews. Use `@coderabbitai review` in a PR comment. This command will override all review filters that might be set up in the repository settings and will initiate a one-time review
208+
- Help Command: You can at any time post `@coderabbitai help` in a PR comment to get the list of all valid commands
185209

186-
- Pause Reviews: Use `@coderabbitai pause` in a PR comment to halt ongoing reviews.
187-
- Resume Reviews: Enter `@coderabbitai resume` in a PR comment to continue paused reviews.
188-
- On-Demand Reviews: Disable automatic reviews for your repository to switch to on-demand reviews. Use `@coderabbitai review` in a PR comment. This command will override all review filters that might be set up in the repository settings and will initiate a one-time review.
189-
- Help Command: You can at any time post `@coderabbitai help` in a PR comment to get the list of all valid commands.
210+
## October 12, 2023
211+
### YML File Customization
190212

191-
## Customization CodeRabbit with YML File
192-
#### Oct 12, 2023
193213
CodeRabbit customizations made easy! You can now customize CodeRabbit using a YML file from your repository. To learn more, refer to our comprehensive documentation on customizing CodeRabbit.
194214

195-
## Path-Based Review Instructions in CodeRabbit
196-
#### Sep 21, 2023
197-
#### Path based instru EFF9 ctions
215+
## September 21, 2023
216+
### Path-Based Review Instructions
198217

199218
This section explains how to add custom code review instructions for the entire project or specific file paths in your project using glob patterns. Developers can provide tailored review guidelines based on the file paths. These instructions are needed only if you want the reviewer to follow specific instructions besides the standard review.
200219

201220
Adding file path prompts allows developers to specify custom instructions for different parts of the codebase. For example, you may want to enforce style guide by file types or directories.
202221

203-
Sample Usage
204-
222+
Sample Usage:
205223
```
206224
path: **/*.js
207225
instructions: Review the javascript code against the google javascript style guide and point out any mismatches
@@ -210,16 +228,12 @@ instructions: Review the javascript code against the google javascript style gui
210228
```
211229
path: tests/**.*
212230
instructions: Review the following unit test code written using the Mocha test library. Ensure that: The code adheres to best practices associated with Mocha. Descriptive test names are used to clearly convey the intent of each test.
213-
214231
```
215232

216-
:::note
217-
218-
- Paths accept glob patterns.
219-
- Instructions generally work well for specific additional instructions. However, they are not that effective if you are instructing AI not to do something.
220-
- Test the review feedback on pull requests and tailor as necessary.
221-
222-
:::
233+
> Note:
234+
> - Paths accept glob patterns
235+
> - Instructions generally work well for specific additional instructions. However, they are not that effective if you are instructing AI not to do something
236+
> - Test the review feedback on pull requests and tailor as necessary
223237
224238
## Sep 19, 2023 - Introducing CodeRabbit for GitLab Integration
225239

0 commit comments

Comments
 (0)
0