Skip to content

Commit

Permalink
Add note about Sidekiq::Job
Browse files Browse the repository at this point in the history
Sidekiq::Worker has been renamed as Sidekiq::Job. See;

* Sidekiq::Job added as an alias in v6.3: https://github.com/sidekiq/sidekiq/blob/main/Changes.md#630
* Sidekiq::Worker replaced with Sidekiq::Job and Sidekiq::Worker retained as an alias in v6.4: https://github.com/sidekiq/sidekiq/blob/main/Changes.md#640
  • Loading branch information
jrmhaig authored and marcelolx committed Nov 28, 2023
1 parent 64b00b9 commit ab177fb
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ class HelloWorld
end
```

__Note:__ In Sidekiq v6.3 `Sidekiq::Job` was introduced as an alias for `Sidekiq::Worker`. `Sidekiq::Worker` has been officially deprecated in Sidekiq v7 although it still exists for backwards compatibility. It is therefore recommended to use `include Sidekiq::Job` in the above example unless an older version of Sidekiq is required.

``` yaml
# config/sidekiq.yml

Expand Down

0 comments on commit ab177fb

Please sign in to comment.