Skip to content

Latest commit

 

History

History
101 lines (69 loc) · 2.71 KB

README.md

File metadata and controls

101 lines (69 loc) · 2.71 KB
Raw

Skedjewel

A scheduled Sidekiq job runner written in Crystal.

Usage

Create a file at config/skedjewel.yml specifying the desired jobs schedule and other configuration.

Example:

# config/skedjewel.yml

config:
  app_redis_db: 0
  sidekiq_redis_db: 1
  time_zone: America/Chicago

jobs:
  DataMonitors::Launcher: '**:07' # hourly at 7 minutes after
  SendLogReminderEmails: '**:**' # every minute
  TruncateTables: '04:58' # daily at 4:58am Central Time

You can print the Skedjewel version:

$ skedjewel --version

Installation

Start by adding something like this to your Procfile:

clock: bin/skedjewel

Now, you need to download the appropriate binary and put it in the bin/ directory of your Rails app.

Binaries are released for both MacOS and for Linux. The latest release binaries are available here.

In development

On your development machine, you can manually download the appropriate binary and put it in the bin/ directory of your Rails project.

You'll also want to add /bin/skedjewel to your repository's .gitignore file.

In production

To use Skedjewel in production, you'll need to download the appropriate binary as part of your deploy process.

Perhaps your deploy process invokes the assets:precompile rake task? If so, then you could enhance that rake task with the following:

# lib/tasks/assets.rake

Rake::Task['assets:precompile'].enhance do
  # install skedjewel
  bin_path = Rails.root.join('bin')
  skedjewel_url =
    'https://github.com/davidrunger/skedjewel/releases/download/v0.0.2/skedjewel-v0.0.2-linux'
  system(<<~SH.squish, exception: true)
    curl -L #{skedjewel_url} > skedjewel &&
      mv skedjewel #{bin_path}/ &&
      chmod a+x #{bin_path}/skedjewel
  SH
end

Note that a Skedjewel version is hardcoded at two places in that URL. You'll update Skedjewel by updating those version numbers.

An easier-to-install alternative: Schedjewel

Schedjewel is a Ruby gem with very similar functionality. It's also maintained by me, @davidrunger.

Installing Schedjewel as a gem in your project is simpler than installing the Skedjewel binaries, so if you're looking for convenience and simplicity, you might consider using Schedjewel instead. The primary downside of using Schedjewel rather than Skedjewel is that Schedjewel (the Ruby gem) uses more memory.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/davidrunger/skedjewel.

License

This library is available as open source under the terms of the MIT License.