Prerelease v-9.6.1-pre-01 (#10330)

[msynk]

closes #10330

Summary by CodeRabbit

• Chores
  • Upgraded version numbers from 9.6.0 to 9.6.1-pre-01 across the application and its dependencies.
  • Ensured consistency of version indicators in configuration and service worker components.

[coderabbitai]

Walkthrough

The changes update version strings throughout the codebase—from JavaScript and TypeScript files to C# project files and build configuration files. All instances of the previous version "9.6.0" are replaced with the pre-release "9.6.1-pre-01". This includes updates in version comments, variable declarations, package references, and template installation instructions without modifying any core functionality.

Changes

Files	Change Summary
src/…/bit-besql.js, src/BlazorUI/…/general.ts, src/Bswup/…/*.ts, src/Bup/…/*.ts, src/Butil/…/butil.ts, src/…/service-worker*.js	Updated version strings from 9.6.0 to 9.6.1-pre-01 in comments and variable declarations.
src/…/*.csproj (BlazorUI Demo, Websites, Templates, etc.)	Updated package references (e.g., Bit.CodeAnalyzers, Bit.SourceGenerators, Bit.Bswup, etc.) to version 9.6.1-pre-01.
src/…/*.props, src/…/Directory.Build.props, src/…/Directory.Packages.props	Modified build and configuration files to update <ReleaseVersion> and template version comments from 9.6.0 to 9.6.1-pre-01.
src/…/Templates03GettingStartedPage.razor and its code-behind	Updated installation instructions and command strings to reference the new pre-release version.

Assessment against linked issues

Objective	Addressed	Explanation
Prerelease v-9.6.1-pre-01 (#10330)	✅

Poem

I'm a bunny coding late at night,
Hopping through version bumps with delight.
From 9.6.0 I leaped ahead,
To a pre-release path where updates are spread.
With gentle hops and joyful glee,
I celebrate changes with a twitch of my ear!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5f11d76 and 27e27f5.

📒 Files selected for processing (46)

• src/Besql/Bit.Besql/wwwroot/bit-besql.js (1 hunks)
• src/Bit.Build.props (1 hunks)
• src/BlazorUI/Bit.BlazorUI/Scripts/general.ts (1 hunks)
• src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Bit.BlazorUI.Demo.Server.csproj (1 hunks)
• src/BlazorUI/Demo/Bit.BlazorUI.Demo.Shared/Bit.BlazorUI.Demo.Shared.csproj (1 hunks)
• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Bit.BlazorUI.Demo.Client.Core.csproj (1 hunks)
• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Maui/Bit.BlazorUI.Demo.Client.Maui.csproj (1 hunks)
• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Web/Bit.BlazorUI.Demo.Client.Web.csproj (1 hunks)
• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Web/wwwroot/service-worker.published.js (1 hunks)
• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Windows/Bit.BlazorUI.Demo.Client.Windows.csproj (1 hunks)
• src/BlazorUI/Demo/Directory.Build.props (1 hunks)
• src/Bswup/Bit.Bswup.Demo/wwwroot/service-worker.js (1 hunks)
• src/Bswup/Bit.Bswup.Demo/wwwroot/service-worker.published.js (1 hunks)
• src/Bswup/Bit.Bswup.NewDemo/Bit.Bswup.NewDemo.Client/wwwroot/service-worker.js (1 hunks)
• src/Bswup/Bit.Bswup.NewDemo/Bit.Bswup.NewDemo.Client/wwwroot/service-worker.published.js (1 hunks)
• src/Bswup/Bit.Bswup/Scripts/bit-bswup.progress.ts (1 hunks)
• src/Bswup/Bit.Bswup/Scripts/bit-bswup.sw-cleanup.ts (1 hunks)
• src/Bswup/Bit.Bswup/Scripts/bit-bswup.sw.ts (1 hunks)
• src/Bswup/Bit.Bswup/Scripts/bit-bswup.ts (1 hunks)
• src/Bswup/FullDemo/Client/wwwroot/service-worker.js (1 hunks)
• src/Bswup/FullDemo/Client/wwwroot/service-worker.published.js (1 hunks)
• src/Bup/Bit.Bup/Scripts/bit-bup.progress.ts (1 hunks)
• src/Bup/Bit.Bup/Scripts/bit-bup.ts (1 hunks)
• src/Butil/Bit.Butil/Scripts/butil.ts (1 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty.Client/BlazorEmpty.Client.csproj (2 hunks)
• src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/BlazorEmpty.csproj (2 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/wwwroot/service-worker.published.js (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Build.props (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Packages.props (2 hunks)
• src/Websites/Careers/src/Bit.Websites.Careers.Client/Bit.Websites.Careers.Client.csproj (1 hunks)
• src/Websites/Careers/src/Bit.Websites.Careers.Client/wwwroot/service-worker.published.js (1 hunks)
• src/Websites/Careers/src/Bit.Websites.Careers.Server/Bit.Websites.Careers.Server.csproj (1 hunks)
• src/Websites/Careers/src/Bit.Websites.Careers.Shared/Bit.Websites.Careers.Shared.csproj (1 hunks)
• src/Websites/Careers/src/Directory.Build.props (1 hunks)
• src/Websites/Platform/src/Bit.Websites.Platform.Client/Bit.Websites.Platform.Client.csproj (1 hunks)
• src/Websites/Platform/src/Bit.Websites.Platform.Client/Pages/Templates/Templates03GettingStartedPage.razor (1 hunks)
• src/Websites/Platform/src/Bit.Websites.Platform.Client/Pages/Templates/Templates03GettingStartedPage.razor.cs (1 hunks)
• src/Websites/Platform/src/Bit.Websites.Platform.Client/wwwroot/service-worker.published.js (1 hunks)
• src/Websites/Platform/src/Bit.Websites.Platform.Server/Bit.Websites.Platform.Server.csproj (1 hunks)
• src/Websites/Platform/src/Bit.Websites.Platform.Shared/Bit.Websites.Platform.Shared.csproj (1 hunks)
• src/Websites/Platform/src/Directory.Build.props (1 hunks)
• src/Websites/Sales/src/Bit.Websites.Sales.Client/Bit.Websites.Sales.Client.csproj (1 hunks)
• src/Websites/Sales/src/Bit.Websites.Sales.Client/wwwroot/service-worker.published.js (1 hunks)
• src/Websites/Sales/src/Bit.Websites.Sales.Server/Bit.Websites.Sales.Server.csproj (1 hunks)
• src/Websites/Sales/src/Bit.Websites.Sales.Shared/Bit.Websites.Sales.Shared.csproj (1 hunks)
• src/Websites/Sales/src/Directory.Build.props (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build and test for release

🔇 Additional comments (63)

src/Butil/Bit.Butil/Scripts/butil.ts (1)

2-2: Version Update Consistency:
The update to the version string '9.6.1-pre-01' is correctly applied to both BitButil.version and window['bit-butil version']. This ensures consistency with the new pre-release version across the BitButil module.

src/Websites/Careers/src/Directory.Build.props (1)

1-1: Template Comment Update:
The version template in the comment has been updated from v-9.6.0 to v-9.6.1-pre-01, accurately reflecting the intended pre-release version without affecting the build properties.

src/Websites/Sales/src/Directory.Build.props (1)

1-1: Template Comment Update:
The updated version comment now states v-9.6.1-pre-01, which aligns with the new pre-release version changes across the project. This update maintains consistency across project templates.

src/Websites/Careers/src/Bit.Websites.Careers.Client/wwwroot/service-worker.published.js (1)

1-1: Service Worker Version Annotation:
The version comment at the top of the service worker file is now updated to 9.6.1-pre-01. This change preserves uniformity with other version updates across the project.

src/Bswup/Bit.Bswup.Demo/wwwroot/service-worker.js (1)

1-1: Demo Service Worker Version Update:
The version comment in the demo service worker file has been updated to 9.6.1-pre-01, which is consistent with the pre-release version updates applied throughout the codebase.

src/BlazorUI/Demo/Directory.Build.props (1)

1-1: Version Comment Update in Template
The file’s header comment has been updated to reflect the pre-release version "v-9.6.1-pre-01". This change is consistent with the overall version update strategy of the PR.

src/BlazorUI/Bit.BlazorUI/Scripts/general.ts (1)

1-1: Updated Version String for BitBlazorUI
The version assignment for the BitBlazorUI object is updated to "9.6.1-pre-01" on line 1. This ensures that both the global window reference and the BitBlazorUI object reflect the new pre-release version correctly.

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Web/wwwroot/service-worker.published.js (1)

1-1: Service Worker Version Comment Updated
The version comment at the top of the service worker file now indicates "9.6.1-pre-01", aligning with all other version updates in this release.

src/Websites/Platform/src/Bit.Websites.Platform.Client/wwwroot/service-worker.published.js (1)

1-1: Consistent Version Update in Service Worker
The version comment has been updated to "9.6.1-pre-01" on line 1. This maintains consistency with the project-wide versioning update for the pre-release.

src/Websites/Sales/src/Bit.Websites.Sales.Client/wwwroot/service-worker.published.js (1)

1-1: Service Worker Version Comment Updated
The version comment now correctly reflects "9.6.1-pre-01", which is in line with the coordinated update across the project.

src/Bswup/FullDemo/Client/wwwroot/service-worker.published.js (1)

1-1: Version Comment Update Is Correct

The version string in the top comment has been correctly updated to "9.6.1-pre-01", which aligns with the pre-release naming convention. This minor change is consistent with the overall PR objectives.

src/Bswup/Bit.Bswup.NewDemo/Bit.Bswup.NewDemo.Client/wwwroot/service-worker.published.js (1)

1-1: Accurate Pre-release Version in Comment

The header comment now correctly indicates "9.6.1-pre-01". This simple update ensures that the file documents the right version without affecting functionality.

src/Websites/Platform/src/Directory.Build.props (1)

1-1: Consistent Build Template Version Update

The version in the generated comment on line 1 has been updated to "v-9.6.1-pre-01." This update is in line with the coordinated version bump across the repository, ensuring consistency in build configurations.

src/Bup/Bit.Bup/Scripts/bit-bup.ts (1)

1-2: Updated BitBup Version Assignment

The assignment of BitBup.version (and the corresponding window property) now reflects "9.6.1-pre-01." This change is straightforward and complies with the pre-release update strategy.

🧰 Tools

🪛 Biome (1.9.4)

[error] 1-1: This variable is used before its declaration.

The variable is declared here:

(lint/correctness/noInvalidUseBeforeDeclaration)

src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Build.props (1)

1-1: Template Version Comment Updated Properly

The header comment now states "Generated by bit-bp template v-9.6.1-pre-01," accurately documenting the new pre-release version for the boilerplate template. This update maintains consistency with the rest of the version changes.

src/Besql/Bit.Besql/wwwroot/bit-besql.js (1)

2-2: Version String Update in BitBesql: The version string has been updated to '9.6.1-pre-01', which aligns with the pre-release milestone. Ensure that any external integrations or scripts referencing this version are updated accordingly.

src/Bswup/FullDemo/Client/wwwroot/service-worker.js (1)

1-1: Updated Version Comment: The version comment on line 1 now reflects '9.6.1-pre-01'. This update is consistent and non-intrusive, aligning the service worker script with the pre-release version.

src/Bswup/Bit.Bswup.NewDemo/Bit.Bswup.NewDemo.Client/wwwroot/service-worker.js (1)

1-1: Service Worker Version Update: The version comment has been updated to '9.6.1-pre-01', matching the new pre-release version across the project. No further modifications are needed here.

src/Bswup/Bit.Bswup.Demo/wwwroot/service-worker.published.js (1)

1-1: Published Service Worker Version Update: The version comment now shows '9.6.1-pre-01', ensuring consistency with the updated versions across the repository.

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/wwwroot/service-worker.published.js (1)

2-2: Version Comment Updated: The version comment is updated to '9.6.1-pre-01' and is in line with the changes elsewhere in the project. This update is straightforward and maintains consistency.

src/Bswup/Bit.Bswup/Scripts/bit-bswup.ts (1)

2-2: Version updated to pre-release 9.6.1-pre-01

The version string has been correctly updated from '9.6.0' to '9.6.1-pre-01', reflecting the pre-release version mentioned in the PR objectives.

src/Bswup/Bit.Bswup/Scripts/bit-bswup.sw.ts (1)

1-1: Version updated to pre-release 9.6.1-pre-01

The service worker version string has been correctly updated from '9.6.0' to '9.6.1-pre-01', maintaining consistency with other version updates in this PR.

src/Websites/Platform/src/Bit.Websites.Platform.Client/Pages/Templates/Templates03GettingStartedPage.razor.cs (1)

40-40: Template installation command updated to pre-release version

The command for installing the Bit.Boilerplate project template has been updated to use the new pre-release version '9.6.1-pre-01', ensuring users will get the matching template version.

src/Bswup/Bit.Bswup/Scripts/bit-bswup.sw-cleanup.ts (1)

1-1: Version updated to pre-release 9.6.1-pre-01

The cleanup service worker version string has been correctly updated from '9.6.0' to '9.6.1-pre-01', maintaining version consistency across all components.

src/Bup/Bit.Bup/Scripts/bit-bup.progress.ts (1)

1-1: Version String Update Confirmation

The version string has been updated from '9.6.0' to '9.6.1-pre-01', which aligns with the overall pre-release version bump. Ensure that any client-side logic or diagnostics that depend on this version value are aware of the change.

src/Bswup/Bit.Bswup/Scripts/bit-bswup.progress.ts (1)

1-1: Version Update Verification

The update of window['bit-bswup.progress version'] to '9.6.1-pre-01' is straightforward and consistent with the pre-release bump applied across the codebase. No issues detected.

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Web/Bit.BlazorUI.Demo.Client.Web.csproj (1)

31-37: Project File Dependency Version Bump

The package references for Bit.Bswup, Bit.CodeAnalyzers, and Bit.SourceGenerators are now updated to '9.6.1-pre-01'. This version bump is consistent with the PR objectives. Please verify that any build or publish pipelines correctly handle the pre-release suffix.

src/Websites/Sales/src/Bit.Websites.Sales.Shared/Bit.Websites.Sales.Shared.csproj (1)

9-16: Consistent Package Reference Update

The updates for Bit.CodeAnalyzers and Bit.SourceGenerators to '9.6.1-pre-01' are correctly applied here. This change maintains version consistency across related project files. No further adjustments needed.

src/BlazorUI/Demo/Bit.BlazorUI.Demo.Shared/Bit.BlazorUI.Demo.Shared.csproj (1)

8-15: Unified Dependency Version Update

The upgrade of the Bit.CodeAnalyzers and Bit.SourceGenerators package versions to '9.6.1-pre-01' ensures that shared components are in sync with the pre-release cycle. It is advisable to double-check downstream projects for compatibility with these pre-release versions.

src/Websites/Platform/src/Bit.Websites.Platform.Shared/Bit.Websites.Platform.Shared.csproj (2)

9-12: Update for Bit.CodeAnalyzers Version
The package reference for Bit.CodeAnalyzers has been updated to 9.6.1-pre-01. This is a straightforward version bump—please ensure that any potential API or analyzer behavior changes in the pre-release are verified against your build and test pipelines.

---

13-16: Update for Bit.SourceGenerators Version
The package reference for Bit.SourceGenerators is now set to 9.6.1-pre-01. Confirm that downstream source generation processes and tooling continue to function correctly with this pre-release version.

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Maui/Bit.BlazorUI.Demo.Client.Maui.csproj (2)

88-91: Updated Bit.CodeAnalyzers Reference
The version of Bit.CodeAnalyzers has been changed to 9.6.1-pre-01. This aligns with the overall pre-release update strategy. It’s recommended to verify that the new pre-release package does not introduce breaking changes in build-time analysis.

---

93-96: Updated Bit.SourceGenerators Reference
The version of Bit.SourceGenerators is updated to 9.6.1-pre-01. Ensure that the source generators produce the expected outputs and that there are no regressions in generated code.

src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Bit.BlazorUI.Demo.Server.csproj (2)

12-15: Bit.CodeAnalyzers Version Bump
The Bit.CodeAnalyzers package reference has been updated to the pre-release version 9.6.1-pre-01. This update is simple, but please run integration tests to confirm that any analyzer warnings or errors are still as expected.

---

16-19: Bit.SourceGenerators Version Bump
The update of the Bit.SourceGenerators package to 9.6.1-pre-01 should be verified against your source generation workflows to ensure full compatibility.

src/Websites/Platform/src/Bit.Websites.Platform.Server/Bit.Websites.Platform.Server.csproj (2)

17-20: Updated Bit.CodeAnalyzers in Platform.Server
The package version for Bit.CodeAnalyzers has been bumped to 9.6.1-pre-01. This should contribute to consistency across your projects. It’s advisable to test the build to catch any unexpected analysis behavior.

---

21-24: Updated Bit.SourceGenerators in Platform.Server
The Bit.SourceGenerators package now uses version 9.6.1-pre-01. Please ensure that the update does not affect your resource generation and overall project build output.

src/Websites/Sales/src/Bit.Websites.Sales.Server/Bit.Websites.Sales.Server.csproj (2)

17-20: Version Update for Bit.CodeAnalyzers
The package reference for Bit.CodeAnalyzers in this project is updated to 9.6.1-pre-01. This is part of a coordinated update across multiple projects. Verify that the update does not introduce any new warnings or errors during compilation.

---

21-24: Version Update for Bit.SourceGenerators
The package reference for Bit.SourceGenerators has been updated to 9.6.1-pre-01. Ensure that the source generation process remains stable and that your generated files are correct after this change.

src/Websites/Careers/src/Bit.Websites.Careers.Server/Bit.Websites.Careers.Server.csproj (2)

17-17: Package version updated to match pre-release version.

The version of Bit.CodeAnalyzers has been updated from 9.6.0 to 9.6.1-pre-01, which is consistent with the project-wide version update.

---

21-21: Package version updated to match pre-release version.

The version of Bit.SourceGenerators has been updated from 9.6.0 to 9.6.1-pre-01, which is consistent with the project-wide version update.

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Bit.BlazorUI.Demo.Client.Core.csproj (3)

18-18: Package version updated to match pre-release version.

The version of Bit.BlazorES2019 has been updated from 9.6.0 to 9.6.1-pre-01, which is consistent with the project-wide version update.

---

20-20: Package version updated to match pre-release version.

The version of Bit.CodeAnalyzers has been updated from 9.6.0 to 9.6.1-pre-01, which is consistent with the project-wide version update.

---

24-24: Package version updated to match pre-release version.

The version of Bit.SourceGenerators has been updated from 9.6.0 to 9.6.1-pre-01, which is consistent with the project-wide version update.

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Windows/Bit.BlazorUI.Demo.Client.Windows.csproj (2)

32-32: Package version updated to match pre-release version.

The version of Bit.CodeAnalyzers has been updated from 9.6.0 to 9.6.1-pre-01, which is consistent with the project-wide version update.

---

36-36: Package version updated to match pre-release version.

The version of Bit.SourceGenerators has been updated from 9.6.0 to 9.6.1-pre-01, which is consistent with the project-wide version update.

src/Websites/Careers/src/Bit.Websites.Careers.Shared/Bit.Websites.Careers.Shared.csproj (2)

9-9: Package version updated to match pre-release version.

The version of Bit.CodeAnalyzers has been updated from 9.6.0 to 9.6.1-pre-01, which is consistent with the project-wide version update.

---

13-13: Package version updated to match pre-release version.

The version of Bit.SourceGenerators has been updated from 9.6.0 to 9.6.1-pre-01, which is consistent with the project-wide version update.

src/Bit.Build.props (1)

30-30: Core version updated for pre-release.

The central ReleaseVersion property has been updated from 9.6.0 to 9.6.1-pre-01. This is the source of truth for version information that propagates to package references throughout the codebase.

src/Websites/Platform/src/Bit.Websites.Platform.Client/Pages/Templates/Templates03GettingStartedPage.razor (1)

158-159: Version update for Bit Boilerplate looks good.

The link and installation command have been properly updated to reference the new version 9.6.1-pre-01.

src/Websites/Careers/src/Bit.Websites.Careers.Client/Bit.Websites.Careers.Client.csproj (1)

32-37: Package version updates look consistent.

All Bit package references have been updated from 9.6.0 to 9.6.1-pre-01, maintaining version consistency across the project dependencies.

Also applies to: 41-41

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty/BlazorEmpty.csproj (2)

1-1: Template version comment update looks good.

The version information in the comment has been properly updated to match the new pre-release version.

---

22-22: Package references consistently updated.

All Bit package references have been updated to version 9.6.1-pre-01, maintaining consistency with the PR version update.

Also applies to: 24-27, 29-32

src/Websites/Sales/src/Bit.Websites.Sales.Client/Bit.Websites.Sales.Client.csproj (1)

32-37: Package version updates are consistent.

All Bit package references have been updated from 9.6.0 to 9.6.1-pre-01, maintaining version alignment across the codebase.

Also applies to: 41-41

src/Templates/BlazorEmpty/Bit.BlazorEmpty/BlazorEmpty.Client/BlazorEmpty.Client.csproj (4)

1-1: Version update looks good.

The template version comment has been correctly updated to the new pre-release version.

---

20-20: Package reference version update is correct.

The Bit.BlazorUI package reference has been properly updated to 9.6.1-pre-01.

---

22-25: Package reference version update is correct.

The Bit.CodeAnalyzers package reference has been properly updated to 9.6.1-pre-01, maintaining the same configuration settings.

---

27-30: Package reference version update is correct.

The Bit.SourceGenerators package reference has been properly updated to 9.6.1-pre-01, maintaining the same configuration settings.

src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Packages.props (2)

4-12: Core package versions updated correctly.

All Bit package versions have been consistently updated from 9.6.0 to 9.6.1-pre-01, preparing for the pre-release version.

---

58-58: Conditional package version updated correctly.

The Bit.Besql package version has been properly updated to 9.6.1-pre-01 while maintaining the conditional inclusion logic.

src/Websites/Platform/src/Bit.Websites.Platform.Client/Bit.Websites.Platform.Client.csproj (3)

35-39: Platform client package versions updated correctly.

All core Bit package references have been consistently updated to 9.6.1-pre-01, maintaining alignment with other project files.

---

40-43: CodeAnalyzers package version updated properly.

The Bit.CodeAnalyzers package reference has been updated to 9.6.1-pre-01 while maintaining the same asset configuration.

---

44-47: SourceGenerators package version updated properly.

The Bit.SourceGenerators package reference has been updated to 9.6.1-pre-01 while maintaining the same asset configuration.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.