Update Hangfire monorepo to 1.8.17

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
HangFire (source)	1.7.34 -> 1.8.17
HangFire (source)	1.7.33 -> 1.8.17
Hangfire (source)	1.7.32 -> 1.8.17
Hangfire.AspNetCore (source)	1.7.32 -> 1.8.17
Hangfire.SqlServer (source)	1.7.32 -> 1.8.17

---

Release Notes

HangfireIO/Hangfire (HangFire)

v1.8.17: 1.8.17

Release Notes

Hangfire.SqlServer

• Fixed – InvalidCastException while fetching a job with older schemas regression from 1.8.16.

v1.8.16: 1.8.16

Release Notes

Hangfire.Core

• Changed – Include fewer stack frames in exceptions come from IServerFilter implementations.
• Changed – Don't include file information in the ExceptionDetails property of a FailedState instance.
• Changed – Switch back to CancellationEvent usage instead of CancellationToken.WaitHandle.
• Fixed – Don't commit external transaction in the BackgroundJobStateChanger implementation.
• Fixed – Use safe default serializer settings for Newtonsoft.Json 12.X and below.
• Project – Fix builds for the net451 platform when using .NET 9.0.
• Project – Significantly reduce execution time of unit tests in the RecurringJobSchedulerFacts class.
• Project – Bump Microsoft.CodeAnalysis.NetAnalyzers package to version 9.0.0.

Hangfire.SqlServer

• Changed – Use vanilla ADO.NET when fetching a job in the SqlServerJobQueue implementation.
• Changed – Decrease the LockTimeout time when calling the sp_getapplock procedure to 1 second for less blocking.
• Fixed – SqlException: Must declare the scalar variable "key" in delayed and recurring job schedulers.
• Project – Disable parallel tests execution when building under .NET 9.0.
• Project – Run tests over the latest Microsoft.Data.SqlClient package and the net6.0 platform.
• Project – Reduce execution time of integration tests.
• Project – Disable PoolBlockingPeriod setting on AppVeyor to handle transient test failures.

v1.8.15: 1.8.15

Release Notes

Hangfire.Core

• Added – New AutomaticRetryAttribute.ExceptOn property to skip retries for specific exceptions.
• Changed – Refactor filters pipeline to use less LINQ magic and fewer allocations.
• Changed – Use GetCultureInfo instead of creating an instance in the CaptureCultureAttribute filter.
• Changed – Cache some immutable data to avoid extra allocations.
• Fixed – Improve loopback address detection (by @​meziantou).
• Fixed – Reformulate misleading error messages regarding retry timings (by @​RGFuaWVs).
• Fixed – Problem with missing localizations in the previous version.
• Fixed – Don't hide exception details on Failed Jobs page when the exception message is empty.
• Fixed – Problems with the first restore when using the build.bat command.
• Fixed – Better display of canceled recurring jobs in dashboard.
• Fixed – Less overall allocations with using static delegates and struct-based iterators.
• Fixed – Improve precision of some diagnostic messages in the wait protection logic.
• Fixed – Make all private and internal classes sealed to improve code consistency.
• Fixed – Less overall pressure on garbage collector.

Hangfire.SqlServer

• Changed – Use query template caching based on schema name to avoid excessive string allocations.
• Changed – Use static callbacks almost anywhere to avoid unnecessary delegate allocations.
• Changed – Use QuerySingle* or ReadSingle* where possible to avoid allocating lists.
• Changed – Unify DbCommand and DbParameter creation logic to improve code consistency.

v1.8.14: 1.8.13 & 1.8.14

Release Notes

Hangfire.Core

• Changed – Partial cache for serialization and deserialization in InvocationData to produce less strings.
• Changed – Add caching for default type serializer and resolver.
• Changed – Don't let JobFilter-related logic to show up in profilers.
• Changed – Modify IProfiler to be less allocatey for diagnostic purposes that almost never run.
• Changed – Prefer using CancellationToken.WaitHandle again, since early .NET Core days are gone.
• Changed – Fewer allocations when working with IStateHandler collections in a state machine.
• Fixed – Redirect the "System.Private.Xml.Linq" assembly to the "System.Xml.Linq" one for better interoperability.
• Fixed – Don't throw KeyNotFoundException when recurring job is malformed.
• Fixed – Proper relative path calculation in UrlHelper.To for OWIN-based Dashboard UI (by @​LordJZ).
• Fixed – Typo in the Turkish localization file (by @​ismkdc).
• Project – Switch to a modern PowerShell 7+ to speed up SignPath installation on AppVeyor.

Hangfire.SqlServer

• Changed – Limit polling queries when queues are empty with a semaphore for all configurations.
• Changed – Use per-queue signaling for same-process workers, instead of having a global signal.
• Fixed – Don't silently truncate queue names, throw an exception instead.
• Project – Decrease delays in SQL Server-related tests to complete them faster.

v1.8.12: 1.8.12

Release Notes

Hangfire.Core

• Added – MaxDegreeOfParallelismForSchedulers experimental server option if supported by storage.
• Added – Experimental support for parallel execution of the delayed job scheduler.
• Added – Experimental support for parallel execution of the recurring job scheduler.
• Fixed – Recurring job is scheduled to the past after recovering from error with AddOrUpdate.
• Fixed – AddOrUpdate triggers execution of a recurring job, even if its next execution is in the future.
• Fixed – Two very minor errors in the Swedish localization file (by @​Uglack).

Hangfire.SqlServer

• Fixed – Populate InvocationData and LoadException properties in JobDetails method results.

v1.8.11: 1.8.11

Release Notes

Hangfire.Core

• Changed – Add icons and fix metadata for NuGet packages.
• Changed – Bump ILRepack to version 2.0.27 to avoid problems with internalizing.
• Fixed – "Type exists in both Cronos and Hangfire.Core" exception.

v1.8.10: 1.8.10

Release Notes

Hangfire.Core

• Changed – Added Norwegian translations for new keys (by @​khellang).
• Changed – Update Brazilian Portuguese translation (by @​HugoAlames).
• Changed – Bump Cronos dependency to version 0.8.3.

Hangfire.AspNetCore

• Fixed – Don't check HasStarted in Response.WriteAsync to avoid breaking dispatchers.

Hangfire.SqlServer

• Changed – Bump Dapper for the netstandard2.0 platform to version 2.1.28.
• Changed – Bump Dapper for net451 and netstandard1.3 platforms to version 1.60.6.

Hangfire.Core, Hangfire.NetCore, Hangfire.AspNetCore, Hangfire.SqlServer, Hangfire.SqlServer.Msmq

• Project – Enable NuGet package and DLL signing with a company certificate.
• Project – Require NuGet package signature validation on restore for dependencies.
• Project – Add HangfireIO as a package owner.

v1.8.9: 1.8.9

Release Notes

Please note that version 1.8.8 was unlisted on NuGet because of broken package references.

Hangfire.Core

• Changed – Use Environment.MachineName as a server name if other environment vars aren't available.
• Changed – Bump the Cronos package version from 0.7.1 to 0.8.1.
• Changed – Improve portuguese translations (by @​filipe-silva).
• Fixed – Possible NullReferenceException on the Deleted Jobs page (regression from 1.8.7).
• Project – Enable full source link support with embedded symbols and repository-based sources.
• Project – Enable repeatable package restore using a lock file.
• Project – Run unit tests against the net6.0 platform.
• Project – Modernise the build system and clean up the build scripts.

Hangfire.SqlServer

• Project – Enable full source link support with embedded symbols and repository-based sources.
• Project – Enable repeatable package restore using a lock file.
• Project – Run unit tests against the net6.0 platform.

Hangfire.NetCore

• Project – Enable full source link support with embedded symbols and repository-based sources.
• Project – Enable repeatable package restore using a lock file.

Hangfire.AspNetCore

• Fixed – Don't attempt to write response headers when response has already started (by @​maliming).
• Project – Enable full source link support with embedded symbols and repository-based sources.
• Project – Enable repeatable package restore using a lock file.

v1.8.7: 1.8.7

Release Notes

Hangfire.Core

• Added – Allow using macro expressions like @hourly for recurring jobs (by @​MuhamedAbdalla).
• Added – Show storage time in page footer when supported by storage implementation.
• Added – Show duration and latency columns separately on the Succeeded Jobs page when supported.
• Added – Show the exception column on the Deleted Jobs page when available and supported by storage.
• Changed – Reduce package size by stripping unnecessary locales in Moment.js.
• Changed – Bump Microsoft.Owin package to version 4.2.2.
• Changed – Log a warning message when a server listens to unsupported queue names (by @​MuhamedAbdalla).
• Changed – Use storage time, if available, to show delay warnings in the Dashboard UI.
• Fixed – Proper rendering of generic arguments on the Job Details page (by @​olivermue).
• Fixed – Language inconsistency in the Dashboard UI related to date/time description.
• Fixed – Big stack traces take too long time to be formatted.
• Fixed – Don't throw NullReferenceException from the Scheduled Jobs page when there's a job with missing data.
• Fixed – Don't throw NullReferenceException from the Processing Jobs page when there's a job with missing data.
• Fixed – CSS for Enqueued and Deleted state cards in dark theme.
• Fixed – Log errors instead of throwing an exception when a particular table can't be cleaned.
• Fixed – Avoid logging fatal exceptions when stopping a faulting background process.
• Fixed – Don't display checkboxes in the Dashboard UI when job details can not be fetched.
• Fixed – Scrollbars in WebKit-based browsers are now dark in dark mode.
• Project – Disable tests for netcoreapp1.0 and netcoreapp2.1 targets since they aren't supported in AppVeyor.
• Project – Add a net6.0 target for unit tests instead of the removed ones.
• Project – Modernise projects and build environments to use the newest features.

Hangfire.SqlServer

• Changed – Avoid throwing an exception when a connection string has duplicate property names.
• Project – Disable tests for netcoreapp1.0 and netcoreapp2.1 targets since they aren't supported in AppVeyor.
• Project – Add a net6.0 target for unit tests instead of the removed ones.
• Project – Modernise projects and build environments to use the newest features.

v1.8.6: 1.8.6

Release Notes

Hangfire.Core

• Changed – Update jQuery library in Dashboard UI to version 3.7.1.
• Changed – Mark all types in Hangfire.Annotations with EditorBrowsableAttribute(Never).
• Changed – Change state card colors for the Awaiting state to match the Scheduled state.
• Fixed – Exception when deserializing an instance of the AutomaticRetryAttribute class from JSON.
• Fixed – Add serialization-related constructors for all the exception classes.
• Fixed – Use invariant culture or ordinal comparisons for internal strings.
• Fixed – Use invariant culture when formatting key names for metrics.
• Fixed – Use CurrentCulture instead of CurrentUICulture when displaying time.
• Project – Enable running static analysis by Coverity Scan weekly.
• Project – Enable mandatory static analysis by the Microsoft.CodeAnalysis.NetAnalyzers package.
• Project – Change MSBuild path when building using newer .NET SDKs for Razor views.

Hangfire.SqlServer

• Fixed – Exception in Dashboard UI when schema version is not present in a database.
• Fixed – DbCommand resource leak when releasing a lock detected by static analysis.
• Fixed – Don't add SQL Server-related metrics multiple times in Dashboard UI.

Hangfire.NetCore

• Fixed – Include assembly information to the Hangfire.NetCore assembly.

v1.8.5: 1.8.5

Release Notes

Hangfire.Core

• Added – Possibility to inform a FaviconPath on DashboardOptions (by @​cezar-pimentel).
• Fixed – Inability to restore a disabled recurring job, regression in version 1.8.3.
• Fixed – Make it possible to serialize the AutomaticRetryAttribute filter to JSON.

Hangfire.SqlServer

• Fixed – "Query processor could not produce a query plan" when removing expired counters in Schema 5.

v1.8.4: 1.8.4

Release Notes

Hangfire.Core

• Added – Pass server id from a worker to the PerformContext.ServerId property available in filters.
• Fixed – Send heartbeats until full background processing server shutdown.

Hangfire.NetCore

• Changed – Send the stop signal earlier in the shutdown pipeline when hosting in .NET Core 3.1 or higher.
• Changed – Set processing server to null in hosted service to avoid ObjectDisposedException.
• Fixed – Other IHostedService implementations can block Hangfire server from being stopped.

v1.8.3: 1.8.3

Release Notes

Hangfire.Core

• Changed – Allow to configure MaxLinesInStackTrace for a particular FailedState instance.
• Fixed – Remove job id from schedule when it's not in the Scheduled state for some reason.
• Fixed – Missing invocations of recurring jobs when the new "Ignorable" option is used.
• Fixed – Make DisableConcurrentExecutionAttribute and LatencyTimeoutAttribute serializable.

v1.8.2: 1.8.2

Release Notes

Hangfire.Core

• Changed – Disable transactional job creation feature appeared in 1.8.0.
• Fixed – "Can not start continuation XXX" error when storage supports transactional job creation.

Hangfire.SqlServer

• Fixed – InvalidOperationException with new dashboard metrics when a database has multiple data/log files.

v1.8.1: 1.8.1

Release Notes

Hangfire.Core

• Added – MisfireHandlingMode.Ignorable to avoid scheduling recurring jobs on missed schedules.
• Added – Support disabling dark mode via the DashboardOptions.DarkModeEnabled property.
• Changed – Remove the 1-hour limitation for the WithJobExpirationTimeout configuration method.
• Fixed – Add missing UseDefaultCulture configuration method overloads.
• Fixed – Add missing UseDashboardStylesheet and UseJobDetailsRenderer configuration methods.
• Fixed – Give even more space for identifiers on the Recurring Jobs page.
• Fixed – state-card-state-active color is not very dark (by @​coolhome).
• Fixed – Slightly change chart proportions to fit 4K in Dashboard UI.

Hangfire.SqlServer

• Fixed – Blocked workers regression since 1.7.28 when using multiple servers inside a process.
• Fixed – Target schema version is less than the current schema version error.
• Fixed – Implement database metrics without the need for additional permissions.
• Fixed – Use the forceseek table hint whenever possible to avoid performance drops.

Hangfire.NetCore

• Fixed – Add net461 target for Hangfire.NetCore package to avoid missing method exceptions.

v1.8.0: 1.8.0

Release Notes

Please see more human-friendly release notes in our blog https://www.hangfire.io/blog/2023/04/28/hangfire-1.8.0.html. Please see https://docs.hangfire.io/en/latest/upgrade-guides/upgrading-to-hangfire-1.8.html to learn how to upgrade.

Hangfire.Core

• Breaking – Dropped the NET45 platform target in favor of the NET451 target to support Visual Studio 2022.
• Added – Introduce the Job.Queue property, so jobs now can have their own queue specified.
• Added – Method overloads to create background jobs directly with a custom default queue.
• Added – Method overloads to create recurring jobs directly with a custom default queue.
• Added – IBackgroundJobClient.Create method overloads with the new queue parameter.
• Added – Allow to filter exception types in AutomaticRetryAttribute by using the new OnlyOn property.
• Added – DeletedState now has the persisted Exception property populated after a failure.
• Added – JobContinuationOptions.OnlyOnDeletedState to create continuations after a failure.
• Added – Exception job parameter is passed to continuation when UseResultsInContinuations method is used.
• Added – FromExceptionAttribute to deal with an antecedent exception in a background job continuation.
• Added – Make it possible to specify multiple JobContinuationOptions values for a continuation.
• Added – BackgroundJobServerOptions.IsLightweightServer option to run a server with no storage processes.
• Added – Ability to use custom formattable resource identifiers for the DisableConcurrentExecution filter.
• Added – Pass ServerId to FailedState instances to simplify the debugging on different servers.
• Added – Allow to pass job parameters when creating a job (by @​brian-knoll-micronetonline).
• Added – MisfireHandlingMode.Strict to create a job for each missed recurring job occurrence.
• Added – Support for default culture and UI culture via the UseDefaultCulture configuration method.
• Added – Introduce the captureDefault parameter in the CaptureCulture filter.
• Added – IGlobalConfiguration.UseFilterProvider extension method to unify the configuration.
• Added – Built-in Remove method for JobFilterCollection to remove global filters based on their type.
• Added – CompatibilityLevel.Version_180 flag to avoid storing culture parameters when they are the same as the default ones.
• Changed – Create job atomically when Transaction.CreateJob feature is supported by the storage.
• Changed – Query time from storage in recurring and delayed schedulers when supported by storage.
• Changed – Move job to the DeletedState instead of SucceededState when its invocation was canceled by a filter.
• Changed – Speedup delayed jobs when a custom default queue is specified by avoiding extra state transition.
• Changed – Use UI culture from CurrentCulture parameter when CurrentUICulture one is missing.
• Changed – Increase the default value for the BackgroundJobServerOptions.StopTimeout to 500 ms.
• Deprecated – AddOrUpdate overloads with optional params defined in the RecurringJobManagerExtensions class.
• Deprecated – AddOrUpdate overloads with optional parameters defined in the RecurringJob class.
• Deprecated – AddOrUpdate method overloads with no recurringJobId parameter.
• Deprecated – RecurringJobOptions.QueueName property, new methods should be used instead.
• Breaking – Dropped NET45 platform target in favor of NET451 target to support Visual Studio 2022.

Dashboard UI

• Added – Dark mode support for Dashboard UI depending on the system settings (by @​danillewin).
• Added – Dashboard UI now has a full-width layout to display more data (by @​danillewin).
• Added – Allow to add custom JavaScript and CSS files to the Dashboard UI via the DashboardRoutes class.
• Added – DefaultRecordsPerPage property on the DashboardOptions class (by @​PaulARoy).
• Added – IGlobalConfiguration.UseJobDetailsRenderer method for custom renderers for the Job Details page.
• Added – Display deleted jobs in the Realtime and History graphs when supported by storage.
• Added – IGlobalConfiguration.UseDashboardMetrics extension method to pass multiple metrics at once.
• Added – State renderer for the DeletedState to display its new exception property.
• Added – Support for new MonitoringApi methods for the Awaiting Jobs page.
• Changed – Make it possible to display methods of non-loaded jobs in the Dashboard UI when supported by storage.
• Changed – Improved display of realtime chart with more accents on failed and deleted jobs.
• Changed – Don't display the queue name in the state transition list when it's the default one.
• Changed – Display scheduled job count when the enqueued count is zero on the main metric.

Extensibility

• Added – Factory, StateMachine, and Performer properties to context classes to avoid injecting services.
• Added – Allow to pass custom data to ApplyStateContext and ElectStateContext instances.
• Added – Preserve custom data dictionary between the entire filter chain.
• Added – Allow to pass a transaction to background job state changer when new methods are implemented.
• Changed – Ignore some members when serializing a JobFilterAttribute instance to decrease the payload size.

Storage

• Added – Virtual JobStorage.GetReadOnlyConnection method intended to return JobStorageConnection for replicas.
• Added – Virtual JobStorage.HasFeature method for querying optional features.
• Added – The JobStorageFeatures class to avoid using magic strings in storage features.
• Added – Optional GetSetCount, GetSetContains, and GetUtcDateTime methods for the JobStorageConnection class.
• Added – Optional AcquireDistributedLock and RemoveFromQueue methods for the JobStorageTransaction class.
• Added – Optional CreateJob and SetJobParameter methods for the JobStorageTransaction class.
• Added – Optional ParametersSnapshot property for BackgroundJob and JobData classes to minimize roundtrips in the future.
• Added – Support for transactional acknowledgment using a new storage method for better handling some data loss scenarios.
• Added – Fetch Retries and Awaiting metrics in StatisticsDto properties when supported by storage.
• Added – The JobStorageMonitor class with more available methods for the new features.
• Changed – Allow to query job parameters without additional roundtrip when supported by storage.
• Changed – Expose state data dictionaries in list DTOs when supported by storage.
• Changed – Rely on storage indexing with the Monitoring.AwaitingJobs feature.

Internals

• Added – IBackgroundProcess.UseBackgroundPool now allows to pass thread configuration logic.
• Added – BackgroundJobServerOptions.WorkerThreadConfigurationAction option for custom thread configuration.
• Changed – Allow changing queues on the fly with custom worker configuration.
• Changed – Avoid storage roundtrip to query job data in worker, take data from previous state change.
• Changed – FromParameterAttribute-based logic now always overwrites arguments, even with non-null values.
• Changed – Turn the JobContinuationOptions enum into flags while still possible.
• Changed – Re-implement TaskExtensions.WaitOneAsync only with the RegisterWaitForSingleObject method.
• Changed – ServerHeartbeatProcess now uses ThreadPriority.AboveNormal to prioritize heartbeats.

Hangfire.NetCore

• Added – IApplicationBuilder.UseHangfireServer that accepts custom factory for IBackgroundProcessingServer.
• Added – net451 and netstandard1.3 targets for the package.
• Changed – Use netstandard2.1 target instead of netcoreapp3.0 for the package.
• Changed – Send the "stop" signal earlier when the host supports .NET Standard 2.1.
• Changed – Don't throw ObjectDisposedException when hosted service is disposed twice.

Hangfire.AspNetCore

• Breaking – Make the package to be dependent on Hangfire.NetCore and use the same types.
• Added – IApplicationBuilder.UseHangfireServer that accepts custom factory for IBackgroundProcessingServer.

Hangfire.SqlServer

• Breaking – Prioritise Microsoft.Data.SqlClient package over System.Data.SqlClient one.
• Breaking – Dropped the NET45 platform target in favor of the NET451 target to support Visual Studio 2022.
• Added – Schema 8 migration with fixed JobQueue.Id column to use the bigint type.
• Added – Schema 9 migration that creates an index for the State.CreatedAt column.
• Added – Automatic client package detection based on available types, preferring System.Data.SqlClient (by @​0xced).
• Added – SqlServerStorageOptions.DbProviderFactory option to use a custom provider factory.
• Added – Clean up of old state entries of a non-finished job when InactiveStateExpirationTimeout is set.
• Added – TryAutoDetectSchemaDependentOptions option to automatically enable options based on the schema.
• Added – Optional experimental transactional acknowledge for SQL Server (UseTransactionalAcknowledge option).
• Added – Implement the Connection.GetUtcDateTime feature to make work the new changes in schedulers.
• Added – SqlServerStorage.SchemaVersion metric for Dashboard UI.
• Added – DefaultQueueProvider option to specify a custom default queue provider.
• Changed – Remove dependency on System.Data.SqlClient for Hangfire.SqlServer (by @​0xced).
• Changed – Set default value for the QueuePollInterval option to TimeSpan.Zero.
• Changed – Polling delay when QueuePollInterval is set to zero now defaults to 200 ms.
• Changed – Sliding invisibility timeout-based fetching method is now used by default with a 5-minute timeout.
• Changed – Use command batching by default with a 5-minute maximum timeout.
• Changed – Enable the UseRecommendedIsolationLevel option by default.
• Changed – GetJobData now populates the JobData.ParametersSnapshot property to avoid additional roundtrips.
• Changed – Display scheduled and processing jobs in ascending order in Dashboard UI.
• Changed – Implement the Transaction.AcquireDistributedLock feature.
• Changed – Implement the GetSetCount.Limited feature.
• Changed – Implement the GetSetContains feature.
• Changed – Bump the internal version of Dapper to 2.0.123.
• Changed – Enable common metrics for SQL Server storage to be shown by default.
• Changed – Enable the Monitoring.AwaitingJobs feature for SQL storage.
• Deprecated – UsePageLocksOnDequeue option is now obsolete and doesn't affect anything.

Hangfire.SqlServer.Msmq

• Breaking – Dropped the NET45 platform target in favor of the NET451 target to support Visual Studio 2022.

v1.7.37: 1.7.37

Release Notes

• Fixed – Recurring job is scheduled to the past after recovering from error with AddOrUpdate (backported).
• Fixed – AddOrUpdate triggers execution of a recurring job, even if its next execution is in the future (backported).
• Fixed – Send heartbeats until full background processing server shutdown (backported).

v1.7.36: 1.7.36

Release Notes

Hangfire.Core

• Fixed – Remove job id from schedule when it's not in the Scheduled state for some reason.

Hangfire.NetCore and Hangfire.AspNetCore

• Changed – Set processing server to null in hosted service to avoid ObjectDisposedException.

v1.7.35: 1.7.35

Release Notes

Hangfire.SqlServer

• Fixed – Blocked workers regression since 1.7.28 when using multiple servers inside a process.

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 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 resolve resolve all the CodeRabbit review comments.
• @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.