Add option to skip recurring jobs via environment variable

Author: iamradioactive

README.md

@@ -193,6 +193,8 @@ By default, Solid Queue will try to find your configuration under `config/queue.
 bin/jobs -c config/calendar.yml
 ```
 
+You can also skip all recurring tasks by setting the environment variable `SOLID_QUEUE_SKIP_RECURRING=true`. This is useful for environments like staging, review apps, or development where you don't want any recurring jobs to run. This is equivalent to using the `--skip-recurring` option with `bin/jobs`.
+
 This is what this configuration looks like:
 
 ```yml
@@ -596,6 +598,8 @@ Solid Queue supports defining recurring tasks that run at specific times in the
 bin/jobs --recurring_schedule_file=config/schedule.yml
 ```
 
+You can completely disable recurring tasks by setting the environment variable `SOLID_QUEUE_SKIP_RECURRING=true` or by using the `--skip-recurring` option with `bin/jobs`.
+
 The configuration itself looks like this:
 
 ```yml

lib/solid_queue/cli.rb

@@ -13,7 +13,8 @@ class Cli < Thor
       banner: "SOLID_QUEUE_RECURRING_SCHEDULE"
 
     class_option :skip_recurring, type: :boolean, default: false,
-      desc: "Whether to skip recurring tasks scheduling"
+      desc: "Whether to skip recurring tasks scheduling",
+      banner: "SOLID_QUEUE_SKIP_RECURRING"
 
     def self.exit_on_failure?
       true

lib/solid_queue/configuration.rb

@@ -88,7 +88,7 @@ def default_options
           recurring_schedule_file: Rails.root.join(ENV["SOLID_QUEUE_RECURRING_SCHEDULE"] || DEFAULT_RECURRING_SCHEDULE_FILE_PATH),
           only_work: false,
           only_dispatch: false,
-          skip_recurring: false
+          skip_recurring: ActiveModel::Type::Boolean.new.cast(ENV["SOLID_QUEUE_SKIP_RECURRING"])
         }
       end
 

test/test_helpers/configuration_test_helper.rb

@@ -4,4 +4,18 @@ module ConfigurationTestHelper
   def config_file_path(name)
     Rails.root.join("config/#{name}.yml")
   end
+
+  def with_env(env_vars)
+    original_values = {}
+    env_vars.each do |key, value|
+      original_values[key] = ENV[key]
+      ENV[key] = value
+    end
+
+    yield
+  ensure
+    original_values.each do |key, value|
+      ENV[key] = value
+    end
+  end
 end

test/unit/configuration_test.rb

@@ -85,6 +85,30 @@ class ConfigurationTest < ActiveSupport::TestCase
     assert_processes configuration, :dispatcher, 1, polling_interval: 0.1, recurring_tasks: nil
   end
 
+  test "skip recurring tasks when SOLID_QUEUE_SKIP_RECURRING environment variable is set" do
+    with_env("SOLID_QUEUE_SKIP_RECURRING" => "true") do
+      configuration = SolidQueue::Configuration.new(dispatchers: [ { polling_interval: 0.1 } ])
+      assert_processes configuration, :dispatcher, 1, polling_interval: 0.1
+      assert_processes configuration, :scheduler, 0
+    end
+  end
+
+  test "include recurring tasks when SOLID_QUEUE_SKIP_RECURRING environment variable is false" do
+    with_env("SOLID_QUEUE_SKIP_RECURRING" => "false") do
+      configuration = SolidQueue::Configuration.new(dispatchers: [ { polling_interval: 0.1 } ])
+      assert_processes configuration, :dispatcher, 1, polling_interval: 0.1
+      assert_processes configuration, :scheduler, 1
+    end
+  end
+
+  test "include recurring tasks when SOLID_QUEUE_SKIP_RECURRING environment variable is not set" do
+    with_env("SOLID_QUEUE_SKIP_RECURRING" => nil) do
+      configuration = SolidQueue::Configuration.new(dispatchers: [ { polling_interval: 0.1 } ])
+      assert_processes configuration, :dispatcher, 1, polling_interval: 0.1
+      assert_processes configuration, :scheduler, 1
+    end
+  end
+
   test "validate configuration" do
     # Valid and invalid recurring tasks
     configuration = SolidQueue::Configuration.new(recurring_schedule_file: config_file_path(:recurring_with_invalid))