CHANGELOG.md

Changelog

Unreleased

3.2.0 - 2025-06-22

Changed

• Harmonized interface with capistrano-puma for better ecosystem consistency
• Aligned configuration variable naming patterns
• Unified systemd command execution methods
• Standardized template search order across both gems
• Added documentation reference to example application

3.1.0 - 2025-06-22

Fixed

• Fix undefined method 'as' error by properly calling backend.as (#327)
• Fix inconsistent systemd variable naming (systemctl_user vs sidekiq_systemctl_user)
• Fix systemd lingering configuration issues (#311)
• Fix sidekiq:uninstall to work without sudo for user services (#307)
• Align configuration pattern with capistrano-puma for consistency

Added

• Add sidekiqswarm support for Sidekiq Enterprise
• Add deployment tracking for Sidekiq 7+ metrics (sidekiq_mark_deploy)
• Add login shell option for systemd (sidekiq_use_login_shell)
• Add configurable sidekiq command (sidekiq_command, sidekiq_command_args)
• Add helper tasks for generating multiple config files
• Add comprehensive documentation for per-server configuration (#312)
• Add detailed systemd integration guide (#240)
• Add GitHub Actions CI workflow with Ruby 3.2+ support
• Add COSS specification compliance
• Add shared configuration support with other Capistrano service gems

Changed

• Update minimum Ruby version to 3.2+ (required by Sidekiq 7)
• Use consistent sidekiq-prefixed variables for systemd configuration
• Improve README documentation with shared configuration examples
• Update CI to test with Ruby 3.2 and 3.3
• Enhance systemd service template with configurable features

3.0.0

• Rewrite to match capistrano3-puma api
• Add support for multiple sidekiq configs (processes and queues can be configured with erb)
• Add support to multiple EnvironmentFile
• Add support to multiple EnvironmentVariables
• Default role for sidekiq is now :worker instead of :app
• Remove monit support
• Remove deprecated --index argument for Sidekiq 6.0+ compatibility (#234)

2.3.0 (2022-05-17)

Full Changelog

Merged pull requests:

• fix sidekiq processes naming when count is 1 #300 (seuros)
• Support multiple processes in sidekiq:install #299 (lloydwatkin)
• fix: monit config template #288 (jpickwell)

v2.2.0 (2022-05-16)

Full Changelog

Merged pull requests:

• Allow the definition of service_unit_name #297 (seuros)
• restore sidekiq unit env vars #295 (tayagi-aim)
• Fix a typo in sidekiq:restart #294 (hoppergee)

v2.1.0 (2022-05-15)

Full Changelog

Merged pull requests:

• Fix #253: $HOME is unexpanded in service unit file #291 (nikochiko)
• Update Readme #287 (lesliepoolman)
• Fixed sidekiq.service autostart in --user mode #285 (michaelkhabarov)
• README: Add section about older Systemd versions logging #284 (64kramsystem)
• Avoid using present? #282 (frederikspang)
• Various systemd improvements - Multiple Process Support, Per Process Config, Proper Restarts with timeout and more #279 (jclusso)
• Use File.join for systemd file path #278 (AndrewSverdrup)
• Fix bug in switch_user and dry up common methods to a helpers module #272 (chriscz)
• Update monit integration against Sidekiq 6.0 #271 (7up4)
• Added sidekiq_service_templates_path to manage custom systemd templates #265 (farnsworth)
• Add sidekiq_config, sidekiq_concurrency, and sidekiq_queue support to systemd #262 (ayn)

v2.0.0 (2020-12-19)

Full Changelog

Merged pull requests:

• Upstart update #261 (duhast)

v2.0.0.beta5 (2020-06-25)

Full Changelog

Merged pull requests:

• Minimal working Upstart plugin #255 (duhast)
• Capistrano rbenv uses bundle instead of bundler #252 (uxxman)

v2.0.0.beta4 (2020-06-08)

Full Changelog

Merged pull requests:

• Fix undefined method as error #249 (kyoshidajp)

v2.0.0.beta3 (2020-05-26)

Full Changelog

Merged pull requests:

• Append logs #247 (Paprikas)
• Add "loginctl enable-linger" command to sidekiq systemd install task #246 (Paprikas)
• Setup error output for systemd #245 (Paprikas)
• Use StandardOutput for logging #244 (Paprikas)

v2.0.0.beta2 (2020-05-25)

Full Changelog

Merged pull requests:

• Add sidekiq_service_unit_env_vars option to pass Environment variable… #243 (Paprikas)

v2.0.0.beta1 (2020-05-12)

Full Changelog

Merged pull requests:

• Release 2.0.0 #236 (seuros)

v1.0.3 (2019-09-02)

Full Changelog

Merged pull requests:

• Point readers towards enable lingering for systemd #230 (creativetags)
• Update README#Multiple processes example #215 (tamaloa)
• Add upstart support for start, stop, and quiet #208 (tmiller)
• Fix monit config file name missing application #205 (xiewenwei)

v1.0.2 (2018-04-12)

Full Changelog

v1.0.1 (2018-04-04)

Full Changelog

Merged pull requests:

• Fix accounting of pidfiles per process (when using multiple processes) #197 (jsantos)
• fix fail rolling restart task #196 (idekeita)
• README.md - simple edit, highlight known issue with cap 3 #192 (westonplatter)
• Systemd integration #171 (baierjan)
• update README with instructions for prepending 'bundle exec' #143 (mistidoi)
• Add deploy failure handling to cap v2 and v3. #135 (phillbaker)
• Support custom monit filename #132 (zocoi)

v1.0.0 (2018-01-24)

Full Changelog

Merged pull requests:

• Spring Cleanup #190 (Tensho)
• Convert CHANGELOG to Markdown + Add Unreleased Section #189 (Tensho)
• Prepend _ Before Service Name Index #184 (Tensho)
• Christmas Eve Cleaning 🎅 #183 (Tensho)

v0.20.0 (2017-08-01)

Full Changelog

Merged pull requests:

• Use new capistrano DSL for reenable tasks #177 (Tensho)

v0.10.0 (2016-11-25)

Full Changelog

Merged pull requests:

• add documentation; add note to ensure shared/tmp/pids folder exists i… #168 (elliotwesoff)
• Make sidekiq:stop task perpetually callable #164 (williamn)
• Add missing monit default config options to README #155 (kirrmann)
• Documenting sidekiq_service_name config option #153 (bendilley)
• Fixes identation and Increase documentation with info about :sidekiq_config #131 (ricardokdz)
• Respect both local and global puma_user setting everywhere #122 (jhollinger)

v0.5.4 (2015-10-27)

Full Changelog

Merged pull requests:

• Change pidfile handling, always add index to pidfile name #116 (w1mvy)
• Move Contributors to separate file. #115 (lpaulmp)
• Monit configuration respects options_per_process #113 (kazjote)
• Capistrano 2 fixes #109 (wingrunr21)
• Use SSHKit command_map #104 (hbin)
• Add notice that the pty bug only applies to Capistrano 3. #101 (nTraum)
• Add support for different number of processes per host on monit.cap #100 (okoriko)
• intial support for sidekiq_user #97 (mcb)

v0.5.3 (2015-06-25)

Full Changelog

Merged pull requests:

• Refactored template_sidekiq method #90 (rstrobl)
• added ability to operate without sudo #89 (dreyks)
• Revert "Add nohup when executing start_sidekiq command, for a problem… #88 (seuros)
• Add nohup when executing start_sidekiq command, for a problem with pty. #76 (maruware)
• implemented ability to split sidekiq_roles by count of sidekiq-processes #45 (alexyakubenko)

v0.5.2 (2015-03-20)

Full Changelog

Merged pull requests:

• Set sidekiq_concurrency default value for cap 2 (improves pr #72). #74 (derSascha)

v0.5.1 (2015-03-18)

Full Changelog

Merged pull requests:

• Support sidekiq_concurrency option for capistrano 2 #72 (mrsimo)

v0.5.0 (2015-03-18)

Full Changelog

Merged pull requests:

• Options per process #70 (mrsimo)
• Try execute on the monit.conf mv command #69 (bencrouse)
• Update sidekiq.cap #68 (raulbrito)
• bug fix for generator. #66 (zshannon)
• Fix Readme Issues #63 (ChuckJHardy)
• Set default option for sidekiq queue in capistrano 2 script #62 (brain-geek)
• Update Cap2 Defaults to include config file #61 (davidlesches)
• add customizing the monit templates for sidekiq #60 (SammyLin)
• Add queues setup in capistrano2 task #57 (brain-geek)

v0.4.0 (2014-11-12)

Full Changelog

Merged pull requests:

• Test is Sidekiq actually running when starting with Capistrano 2 #54 (Envek)
• use release_path instead of current_path #50 (flyerhzm)
• Typo #48 (binyamindavid)
• Fix descriptions of monit tasks #47 (jgeiger)

v0.3.8 (2014-09-22)

Full Changelog

Merged pull requests:

• Improve @bensie pull request + unmonitor monit while deploy #46 (Saicheg)

v0.3.7 (2014-09-01)

Full Changelog

Merged pull requests:

• Start Sidekiq as daemon from Monit #40 (dpaluy)
• Sidekiq is properly restarted after a crash when deploying with Capsitrano2 #39 (tribble)

v0.3.6 (2014-08-08)

Full Changelog

Merged pull requests:

• If :sidekiq_config is set, Monit template should use it to start the ser... #35 (joshmyers)
• replace deploy:restart with deploy:publishing for capistrano 3.1 #34 (flyerhzm)
• Fix: test with spaces ignores within #33 (rogercampos)
• Added _cset for :sidekiq_tag #32 (OscarBarrett)

v0.3.5 (2014-07-25)

Full Changelog

Merged pull requests:

• Allow use of sidekiq_tag for capistrano2 #30 (OscarBarrett)

v0.3.4 (2014-07-09)

Full Changelog

Merged pull requests:

• Added concurrency option #26 (ungsophy)
• Fix bug with process index in monit task #21 (0x616E676572)
• You can now use signals to quiet/stop sidekiq, much faster. #18 (penso)
• Check that current_path exists before stopping #16 (alexdunae)
• search pid files in correct directory #12 (levinalex)
• Rolling restart #7 (jlecour)

v0.1.0 (2014-03-24)

Full Changelog

Merged pull requests:

• Cleaner version checking #6 (ghost)
• More robust version checking #4 (jlecour)
• More explicit start command #3 (jlecour)
• Improve pid and log files settings #1 (jlecour)

* This Changelog was automatically generated by github_changelog_generator