From 281fd7a2bbfeb6b6daf3b0df17e121aba3dc8b4e Mon Sep 17 00:00:00 2001 From: karan <karan@coderabbit.ai> Date: Mon, 23 Dec 2024 13:39:58 -0800 Subject: [PATCH 01/11] =?UTF-8?q?=F0=9F=A7=91=E2=80=8D=F0=9F=92=BB=20Add?= =?UTF-8?q?=20multi=20add=20repo=20to=20changelog?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/changelog.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/changelog.md b/docs/changelog.md index 1873f67a..9fd1d9d3 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -5,6 +5,16 @@ description: The latest updates and changes to CodeRabbit. sidebar_position: 13 --- +## December 23, 2024 + +### Simplify Your Workflow: Install CodeRabbit on Multiple Repositories for GitLab and Azure DevOps in One Step! + +We’re thrilled to announce an exciting new feature designed to make your life easier! You can now install CodeRabbit on multiple repositories at once for GitLab and Azure DevOps—eliminating the need to activate each repository individually. + +With this enhancement, all it takes is one simple step: +• Select the repositories you want to activate by checking the boxes next to them. +• Click the “Install Repositories” button to integrate CodeRabbit across multiple projects instantly. + ## December 12, 2024 ### Docstrings(Beta) From e0f7aa65bedc6b3f7bc21b4f5e85b42ed663a8c2 Mon Sep 17 00:00:00 2001 From: karan <karan@coderabbit.ai> Date: Mon, 23 Dec 2024 14:49:16 -0800 Subject: [PATCH 02/11] =?UTF-8?q?=F0=9F=8E=A8=20Changelog=20update=20and?= =?UTF-8?q?=20add=20lines=20for=20each=20change=20log=20seperated=20by=20a?= =?UTF-8?q?=20line=20break?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/changelog.md | 73 +++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 67 insertions(+), 6 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 9fd1d9d3..ae2d6274 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -7,13 +7,16 @@ sidebar_position: 13 ## December 23, 2024 -### Simplify Your Workflow: Install CodeRabbit on Multiple Repositories for GitLab and Azure DevOps in One Step! +### Streamlined Multi-Repository Installation for GitLab and Azure DevOps -We’re thrilled to announce an exciting new feature designed to make your life easier! You can now install CodeRabbit on multiple repositories at once for GitLab and Azure DevOps—eliminating the need to activate each repository individually. +We’re thrilled to announce a significant enhancement to CodeRabbit that simplifies your workflow! You can now install CodeRabbit on multiple repositories simultaneously for GitLab and Azure DevOps, eliminating the need to activate each repository individually. -With this enhancement, all it takes is one simple step: -• Select the repositories you want to activate by checking the boxes next to them. -• Click the “Install Repositories” button to integrate CodeRabbit across multiple projects instantly. +With this update, you can: + +- ✅ Select Multiple Repositories: Check the boxes next to the repositories you wish to activate. +- 🖱️ One-Click Installation: Select the **Install Repositories** button on the top right to integrate CodeRabbit across all selected projects instantly. + +--- ## December 12, 2024 @@ -21,24 +24,32 @@ With this enhancement, all it takes is one simple step: We have launched a new functionality as part of our finishing touches initiative to allow developers to generate docstrings on a pull request. This feature lets you generate docstrings by commenting `@coderabbitai generate docstrings` on any pull request. This works for both new and existing documentation. See [our documentation](https://docs.coderabbit.ai/finishing-touches/docstrings) for details. +--- + ## November 25, 2024 ### Code Review Performance Enhancements with Improved Comment Resolution Logic We have implemented several performance improvements that will enhance the speed of code review and are committed to making code review as efficient as possible across all your web development needs. We have also further refined the logic to reduce duplicate comments once a comment is resolved. +--- + ## November 20, 2024 ### Support for On-premises Learning and GitLab Follow-up Issue Creation Learning is a method for developers to interact with the bot to tune AI specifically for their files, repositories, and codebase for future reviews. We now extend this learning support to our on-premises customers. Additionally, we have enhanced our automated workflow to create follow-up issues based on Merge Request Reviews in GitLab. +--- + ## November 8, 2024 ### ESLint Support We've introduced support for ES Lint, including .vue, .svelte, and .astro, alongside traditional .js, .ts, and .jsx extensions. We've worked on monorepo compatibility with improved Yarn and PNPM workspace support, ensuring seamless integration across your projects. While maintaining your existing ESLint configurations, we simply require all dependencies to be properly defined in your package.json. Note that private plugins aren't currently supported, but we're committed to making code quality maintenance as efficient as possible across all your web development needs +--- + ## October 31, 2024 ### Learnings and Metrics Iteration for CodeRabbit Self-Hosted Customers @@ -52,6 +63,8 @@ We've improved our Learnings and Metrics accessibility for Self-Hosted CodeRabbi - Configuring your .env file, or - Contacting CodeRabbit support for assistance +--- + ## October 30, 2024 ### Microsoft Teams Integration & Bitbucket Support @@ -62,6 +75,8 @@ Our integration capabilities just got a major upgrade with Microsoft Teams and B - 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 +--- + ## October 22, 2024 ### Security and SAST Remediation Improvements @@ -72,6 +87,8 @@ Our integration capabilities just got a major upgrade with Microsoft Teams and B - Improved the [Semgrep Documentation](https://docs.coderabbit.ai/tools/semgrep) - CodeRabbit now automatically detects Semgrep rulesets from default `semgrep.yml` or `semgrep.config.yml` files, eliminating the need for manual configuration +--- + ## September 9, 2024 ### Related PRs and Label suggestions @@ -81,6 +98,8 @@ Our integration capabilities just got a major upgrade with Microsoft Teams and B > Note: Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default). +--- + ## August 15, 2024 ### New Dashboard @@ -97,12 +116,16 @@ What's new: These updates are here to help you get more from the dashboard. Take a look today! +--- + ## July 31, 2024 ### Promote members to admin 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. +--- + ## July 16, 2024 ### New Features and Improvements @@ -136,6 +159,8 @@ We've refined the default settings to be less noisy and more actionable. Additio 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. +--- + ## May 28, 2024 ### New Features and Improvements @@ -160,6 +185,8 @@ We have introduced new commands for interacting with CodeRabbit, detailed under 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. +--- + ## May 23, 2024 ### New Features and Improvements @@ -184,6 +211,8 @@ Users can now customize CodeRabbit to review code in the style of their favorite 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. +--- + ## April 18, 2024 ### Static Analyzers and Linters Integration @@ -192,36 +221,48 @@ CodeRabbit now runs static analyzers, linters and provides one-click fixes for t Are there any specific tools you'd like us to add? Let us know. We'd love to hear your suggestions! +--- + ## April 1, 2024 ### GDPR Compliance Excited to announce that CodeRabbit is now GDPR compliant in accordance with EU regulations! +--- + ## March 12, 2024 ### GitHub Check Fixes 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. +--- + ## March 11, 2024 ### SOC 2 Type II Compliance CodeRabbit is now SOC 2 Type II compliant to ensure top-tier security, availability, integrity, and privacy for our users. +--- + ## March 2, 2024 ### Enhanced Markdown Review 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. +--- + ## January 17, 2024 ### Self-hosted GitLab Integration CodeRabbit now offers integration for self-hosted GitLab. Refer to the [setup instructions](https://docs.coderabbit.ai/integrations/self-hosted-gitlab). +--- + ## January 2, 2024 ### Deep Insights Feature Release @@ -237,12 +278,16 @@ Here are some uses cases: 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. +--- + ## December 18, 2023 ### Request Changes Workflow 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. +--- + ## December 5, 2023 ### Multiple Features Release @@ -263,24 +308,32 @@ You can now integrate Jira and Linear into CodeRabbit. This would be used for ad 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. +--- + ## November 5, 2023 ### Issue Validation 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. +--- + ## November 1, 2023 ### Committable Suggestions Review comments can now post committable suggestions that can be committed within the pull request with a single click. +--- + ## October 28, 2023 ### Resolve Command Use `@coderabbitai resolve` to mark all the CodeRabbit review comments as resolved all at once. +--- + ## October 23, 2023 ### CodeRabbit Commands @@ -292,12 +345,16 @@ Introducing additional CodeRabbit commands for managing code reviews: - 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 - Help Command: You can at any time post `@coderabbitai help` in a PR comment to get the list of all valid commands +--- + ## October 12, 2023 ### YML File Customization 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. +--- + ## September 21, 2023 ### Path-Based Review Instructions @@ -324,6 +381,10 @@ instructions: Review the following unit test code written using the Mocha test l > - Instructions generally work well for specific additional instructions. However, they are not that effective if you are instructing AI not to do something > - Test the review feedback on pull requests and tailor as necessary -## Sep 19, 2023 - Introducing CodeRabbit for GitLab Integration +--- + +## Sep 19, 2023 + +### Introducing CodeRabbit for GitLab Integration CodeRabbit is now available for GitLab! We know many of you have been waiting for this integration. Thank you for your patience. Sign up for the free trial! From 532fb1adbae881d808248af228552b23223c9df9 Mon Sep 17 00:00:00 2001 From: karan <karan@coderabbit.ai> Date: Mon, 23 Dec 2024 15:11:29 -0800 Subject: [PATCH 03/11] Some additional fixes --- docs/changelog.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index ae2d6274..00705af1 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -59,9 +59,9 @@ We've improved our Learnings and Metrics accessibility for Self-Hosted CodeRabbi **Setup:** - Generate an API key in the CodeRabbit UI -- Enable Learnings and Metrics by: -- Configuring your .env file, or -- Contacting CodeRabbit support for assistance +- Enable Learnings and Metrics by either: + - Configuring your .env file + - Contacting CodeRabbit support for assistance --- @@ -132,16 +132,18 @@ You can now promote members in your organization to admins within CodeRabbit. Ad #### Learnings Page -We're thrilled to announce the new "Learnings" page! Users can now interact with learnings captured in PR comments, enhancing future reviews. Log into CodeRabbit to see the page, where you can filter learnings by Repository, File Path, and User. You can also edit or delete learnings that are no longer relevant to your project. +We're thrilled to announce the new **Learnings** page! Users can now interact with learnings captured in PR comments, enhancing future reviews. Log into CodeRabbit to see the page, where you can filter learnings by Repository, File Path, and User. You can also edit or delete learnings that are no longer relevant to your project. #### Reports (Beta) Page -Introducing the beta release of "Reports"! Generate recurring summaries of team performance and PR reviews with features like: +Introducing the beta release of **Reports**! + +Generate recurring summaries of team performance and latest PR reviews with features like: - Scheduling regular report generation - Specifying parameters such as repository, team, user, or label -- Selecting report types (Daily Stand-Up, Sprint Report, Release Notes, Custom) -- Enabling delivery channels like Email, Slack, and Discord +- Selecting report styles (Daily Stand-Up, Sprint Report, Release Notes, Custom) +- Enabling your choice of delivery channel (Email, Slack, or Discord) #### Sequence Diagrams Configuration @@ -259,7 +261,7 @@ CodeRabbit now offers a more comprehensive review of the markdown changes. In ad ### Self-hosted GitLab Integration -CodeRabbit now offers integration for self-hosted GitLab. Refer to the [setup instructions](https://docs.coderabbit.ai/integrations/self-hosted-gitlab). +CodeRabbit now supports integration with Self-Hosted GitLab instances. Check out our [setup instructions](https://docs.coderabbit.ai/integrations/self-hosted-gitlab) for detailed instructions. --- @@ -294,7 +296,7 @@ Enable Request Changes review workflow for CodeRabbit reviews via .coderabbit.ya #### Learnings -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. +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. #### Codebase Verification @@ -302,11 +304,11 @@ Verifies the reference of the changes on the overall codebase and identifies mis #### Jira and Linear Integrations -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. +You can now integrate Jira and Linear with CodeRabbit to provide additional context when reviewing pull requests. If you use either of these systems, we highly recommend enabling this integration for a more seamless experience. Stay tuned—more integrations are coming soon! #### Related Issues -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. +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 is unavailable for users who have opted out of data collection. --- From 75b051fd8eff616003fc1520d893162767a9416a Mon Sep 17 00:00:00 2001 From: karan <karan@coderabbit.ai> Date: Mon, 23 Dec 2024 15:41:32 -0800 Subject: [PATCH 04/11] Bold the tools --- docs/changelog.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 00705af1..8acb0b1b 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -153,9 +153,9 @@ You can now choose whether to auto-generate sequence diagrams in PR Walkthroughs We've refined the default settings to be less noisy and more actionable. Additionally, we've added new static analysis and security tools: -- Yamllint A linter for YAML files -- Gitleaks A lightweight, open-source secret scanner to prevent security breaches -- Checkov Scans infrastructure as code for misconfigurations before they become security issues +- **Yamllint**: A linter for YAML files +- **Gitleaks**: A lightweight, open-source secret scanner to prevent security breaches +- **Checkov**: Scans infrastructure as code for misconfigurations before they become security issues #### GitLab Integration Update From b39c7574d7233926fd7b7eca3c7301cdc7f4ae6f Mon Sep 17 00:00:00 2001 From: karan <karan@coderabbit.ai> Date: Mon, 23 Dec 2024 15:55:09 -0800 Subject: [PATCH 05/11] Update poor grammar --- docs/changelog.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 8acb0b1b..00b83477 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -38,7 +38,7 @@ We have implemented several performance improvements that will enhance the speed ### Support for On-premises Learning and GitLab Follow-up Issue Creation -Learning is a method for developers to interact with the bot to tune AI specifically for their files, repositories, and codebase for future reviews. We now extend this learning support to our on-premises customers. Additionally, we have enhanced our automated workflow to create follow-up issues based on Merge Request Reviews in GitLab. +Learnings enable developers to fine-tune the AI for their specific files, repositories, and codebase, enhancing future reviews. We’re excited to extend this feature to our on-premises customers. Additionally, we’ve improved our automated workflow to create follow-up issues directly from Merge Request reviews in GitLab. --- @@ -46,7 +46,9 @@ Learning is a method for developers to interact with the bot to tune AI specific ### ESLint Support -We've introduced support for ES Lint, including .vue, .svelte, and .astro, alongside traditional .js, .ts, and .jsx extensions. We've worked on monorepo compatibility with improved Yarn and PNPM workspace support, ensuring seamless integration across your projects. While maintaining your existing ESLint configurations, we simply require all dependencies to be properly defined in your package.json. Note that private plugins aren't currently supported, but we're committed to making code quality maintenance as efficient as possible across all your web development needs +We’re excited to announce support for **ESLint**, now extending to .vue, .svelte, and .astro files, in addition to the traditional .js, .ts, and .jsx extensions. We’ve enhanced compatibility for monorepos, offering improved integration with Yarn and Pnpm workspaces for seamless project management. + +Our solution respects your existing ESLint configurations, requiring only that all dependencies are properly defined in your package.json. Please note that private plugins are not yet supported. We’re dedicated to streamlining code quality maintenance and making it as efficient as possible across your web development projects. --- @@ -54,7 +56,7 @@ We've introduced support for ES Lint, including .vue, .svelte, and .astro, along ### Learnings and Metrics Iteration for CodeRabbit Self-Hosted Customers -We've improved our Learnings and Metrics accessibility for Self-Hosted CodeRabbit customers to provide a more seamless experience. Track learning patterns and insights more easily, with API key generation now available directly from the interface. +We’ve enhanced the accessibility of Learnings and Metrics for self-hosted CodeRabbit customers, delivering a more seamless experience. Easily track learning patterns and insights, with the added convenience of generating API keys directly within the interface. **Setup:** @@ -69,11 +71,11 @@ We've improved our Learnings and Metrics accessibility for Self-Hosted CodeRabbi ### Microsoft Teams Integration & Bitbucket Support -Our integration capabilities just got a major upgrade with Microsoft Teams and Bitbucket support. +Our integration capabilities just got a major upgrade with **Microsoft Teams** and **Bitbucket** support. -- Microsoft Teams integration is with scheduled reporting system and direct notification pipeline to keep your team informed. +- Microsoft Teams integration is now available as part of the Reporting feature, providing a direct notification pipeline to keep your team informed and up-to-date. -- 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 +- We've also launched Bitbucket Data Center support including Pull Request integration with essential review functionalities, detailed summaries, and inline comments to seamlessly apply review suggestions. --- From 6b08ce5c003bff78c6839fa633a85cd8d4446758 Mon Sep 17 00:00:00 2001 From: karan <karan@coderabbit.ai> Date: Mon, 23 Dec 2024 15:58:59 -0800 Subject: [PATCH 06/11] more fixes --- docs/changelog.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 00b83477..8259d471 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -83,10 +83,10 @@ Our integration capabilities just got a major upgrade with **Microsoft Teams** a ### Security and SAST Remediation Improvements -- Enabling comprehensive security analysis directly from context within GitHub Checks +- Enabling comprehensive security analysis directly from context within GitHub Checks. - 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! -- 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 -- Improved the [Semgrep Documentation](https://docs.coderabbit.ai/tools/semgrep) +- 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. +- Improved the [Semgrep Documentation](https://docs.coderabbit.ai/tools/semgrep). - CodeRabbit now automatically detects Semgrep rulesets from default `semgrep.yml` or `semgrep.config.yml` files, eliminating the need for manual configuration --- @@ -95,8 +95,8 @@ Our integration capabilities just got a major upgrade with **Microsoft Teams** a ### Related PRs and Label suggestions -- Possibly related PRs: The walkthrough comment now includes a list of potentially related PRs to help you recall the past context -- 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 +- **Possibly Related PRs**: The walkthrough comment now provides a list of potentially related PRs, helping you quickly recall relevant context from past work. +- **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 via configuration file. > Note: Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default). From eb88423b53e96116d3475641c3884e658a827686 Mon Sep 17 00:00:00 2001 From: karan <karan@coderabbit.ai> Date: Mon, 23 Dec 2024 15:59:14 -0800 Subject: [PATCH 07/11] another fix --- docs/changelog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.md b/docs/changelog.md index 8259d471..e23539c4 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -87,7 +87,7 @@ Our integration capabilities just got a major upgrade with **Microsoft Teams** a - 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! - 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. - Improved the [Semgrep Documentation](https://docs.coderabbit.ai/tools/semgrep). -- CodeRabbit now automatically detects Semgrep rulesets from default `semgrep.yml` or `semgrep.config.yml` files, eliminating the need for manual configuration +- CodeRabbit now automatically detects Semgrep rulesets from default `semgrep.yml` or `semgrep.config.yml` files, eliminating the need for manual configuration. --- From a8ae02e07dcfee7a428cf23c5afefbc8e27fc790 Mon Sep 17 00:00:00 2001 From: karan <karan@coderabbit.ai> Date: Mon, 23 Dec 2024 16:17:21 -0800 Subject: [PATCH 08/11] more fixes --- docs/changelog.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index e23539c4..20103941 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -84,7 +84,7 @@ Our integration capabilities just got a major upgrade with **Microsoft Teams** a ### Security and SAST Remediation Improvements - Enabling comprehensive security analysis directly from context within GitHub Checks. -- 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! +- CodeRabbit now seamlessly integrates with top SAST tools that create github check annotation comments such as: Codacy, SonarCloud, Code Climate, GitHub Advanced Security, Palo Alto Prisma Cloud, and more! - 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. - Improved the [Semgrep Documentation](https://docs.coderabbit.ai/tools/semgrep). - CodeRabbit now automatically detects Semgrep rulesets from default `semgrep.yml` or `semgrep.config.yml` files, eliminating the need for manual configuration. @@ -122,9 +122,9 @@ These updates are here to help you get more from the dashboard. Take a look toda ## July 31, 2024 -### Promote members to admin +### Grant Admin Privileges to Members -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. +You can now grant admin privileges to members of your organization in CodeRabbit. Admins will have the ability to manage subscriptions and seat allocations for the organization. --- @@ -134,7 +134,7 @@ You can now promote members in your organization to admins within CodeRabbit. Ad #### Learnings Page -We're thrilled to announce the new **Learnings** page! Users can now interact with learnings captured in PR comments, enhancing future reviews. Log into CodeRabbit to see the page, where you can filter learnings by Repository, File Path, and User. You can also edit or delete learnings that are no longer relevant to your project. +We're thrilled to announce the new **Learnings** page! Users can now interact with learnings captured in PR comments, enhancing future reviews. Log into CodeRabbit and navigate to the Learnings tab, where you can filter learnings by Repository, File Path, and User. You can also edit or delete learnings that are no longer relevant to your project. #### Reports (Beta) Page @@ -149,7 +149,7 @@ Generate recurring summaries of team performance and latest PR reviews with feat #### Sequence Diagrams Configuration -You can now choose whether to auto-generate sequence diagrams in PR Walkthroughs. Configure this via the CodeRabbit settings page or by setting reviews.sequence_diagrams in the .coderabbit.yaml file. +You can now choose whether to auto-generate sequence diagrams in the PR Walkthrough comment. Enable this via the CodeRabbit settings page or by setting reviews.sequence_diagrams in the .coderabbit.yaml file. #### Enhanced Tool Settings & New Analysis Tools @@ -171,11 +171,11 @@ The GitLab integration now offers more flexibility and security. Users can use P #### Sequence Diagrams -CodeRabbit now generates sequence diagrams of code changes, enhancing reviewers' ability to understand the flow of control. +CodeRabbit now generates sequence diagrams for code changes, providing reviewers with a clear visualization of the control flow for improved understanding. #### Auto-Generate PR Titles -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. +A new option, `auto_title_placeholder`, is now available and defaults to `@coderabbitai` title. This feature allows users to set a placeholder title, enabling CodeRabbit to automatically generate an appropriate title when the review process begins. #### New Commands @@ -197,11 +197,17 @@ We have been observing that many PRs get closed quickly and CodeRabbit continues #### Review Settings -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. +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. #### More Static Analysis Support -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. +We are continually expanding our support for static analysis tools. We've recently added support for + +- biome +- hadolint +- ast-grep. + +Update your .coderabbit.yaml file or visit the settings page to enable or disable the tools you wish to use. #### Tone Settings From c1b82db070f4949c60708541911d433c7f0a3281 Mon Sep 17 00:00:00 2001 From: karan <karan@coderabbit.ai> Date: Mon, 23 Dec 2024 16:19:14 -0800 Subject: [PATCH 09/11] another grammar fix --- docs/changelog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.md b/docs/changelog.md index 20103941..2db922b2 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -211,7 +211,7 @@ Update your .coderabbit.yaml file or visit the settings page to enable or disabl #### Tone Settings -Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples: +Users can now personalize CodeRabbit to review code in the style of their favorite characters or personalities. Here are a few of our top examples: - Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!" - Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!" From aac524b086f1fe7b316b31d2c491e6d0abde9bce Mon Sep 17 00:00:00 2001 From: karan <karan@coderabbit.ai> Date: Mon, 23 Dec 2024 16:23:12 -0800 Subject: [PATCH 10/11] more fixes --- docs/changelog.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 2db922b2..d9daa8c1 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -237,7 +237,7 @@ Are there any specific tools you'd like us to add? Let us know. We'd love to hea ### GDPR Compliance -Excited to announce that CodeRabbit is now GDPR compliant in accordance with EU regulations! +Excited to announce that CodeRabbit is now GDPR-compliant in accordance with EU regulations! --- @@ -245,7 +245,7 @@ Excited to announce that CodeRabbit is now GDPR compliant in accordance with EU ### GitHub Check Fixes -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. +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 can 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. --- @@ -294,7 +294,7 @@ Really excited to see how this feature gets used, especially with access to the ### Request Changes Workflow -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. +Enable Request Changes review workflow for CodeRabbit reviews via .coderabbit.yaml under the 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. --- @@ -304,7 +304,7 @@ Enable Request Changes review workflow for CodeRabbit reviews via .coderabbit.ya #### Learnings -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. +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. 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. #### Codebase Verification @@ -393,7 +393,7 @@ instructions: Review the following unit test code written using the Mocha test l --- -## Sep 19, 2023 +## September 19, 2023 ### Introducing CodeRabbit for GitLab Integration From 5c84ad2436f02e5f0926a6ac1bf22aac3e5d35a2 Mon Sep 17 00:00:00 2001 From: karan <karan@coderabbit.ai> Date: Mon, 23 Dec 2024 16:26:49 -0800 Subject: [PATCH 11/11] final change for now --- docs/changelog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.md b/docs/changelog.md index d9daa8c1..a79ec4b2 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -245,7 +245,7 @@ Excited to announce that CodeRabbit is now GDPR-compliant in accordance with EU ### GitHub Check Fixes -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 can 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. +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 can report issues on Pull Requests as annotations. Checks that output logs will be supported shortly. The 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. ---