Skip to content

Commit c6f38b3

Browse files
committed
Change default config file from solid_queue.yml to just queue.yml
Following Solid Cache's change in rails/solid_cache#222. As we aren't still in version 1.0, fine to do this as a breaking change for now.
1 parent cf656a9 commit c6f38b3

File tree

7 files changed

+8
-7
lines changed

7 files changed

+8
-7
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Solid Queue is configured by default in new Rails 8 applications. But if you're
1313
1. `bundle add solid_queue`
1414
2. `bin/rails solid_queue:install`
1515

16-
This will configure Solid Queue as the production Active Job backend, create the configuration files `config/solid_queue.yml` and `config/recurring.yml`, and create the `db/queue_schema.rb`. It'll also create a `bin/jobs` executable wrapper that you can use to start Solid Queue.
16+
This will configure Solid Queue as the production Active Job backend, create the configuration files `config/queue.yml` and `config/recurring.yml`, and create the `db/queue_schema.rb`. It'll also create a `bin/jobs` executable wrapper that you can use to start Solid Queue.
1717

1818
Once you've done that, you will then have to add the configuration for the queue database in `config/database.yml`. If you're using sqlite, it'll look like this:
1919

@@ -90,7 +90,7 @@ We have several types of actors in Solid Queue:
9090

9191
Solid Queue's supervisor will fork a separate process for each supervised worker/dispatcher/scheduler.
9292

93-
By default, Solid Queue will try to find your configuration under `config/solid_queue.yml`, but you can set a different path using the environment variable `SOLID_QUEUE_CONFIG` or by using the `-c/--config_file` option with `bin/jobs`, like this:
93+
By default, Solid Queue will try to find your configuration under `config/queue.yml`, but you can set a different path using the environment variable `SOLID_QUEUE_CONFIG` or by using the `-c/--config_file` option with `bin/jobs`, like this:
9494

9595
```
9696
bin/jobs -c config/calendar.yml

UPGRADING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Upgrading to version 0.9.x
2-
This version changes how recurring tasks are configured. Before, they would be defined as part of the _dispatcher_ configuration. Now they've been upgraded to their own configuration file, and a dedicated process (the _scheduler_) to manage them. Check the _Recurring tasks_ section in the `README` to learn how to configure them in detail.
3-
4-
In short, they live now in `config/recurring.yml` (by default) and follow the same format as before when they lived under `dispatchers > recurring_tasks`.
2+
This version has two breaking changes regarding configuration:
3+
- The default configuration file has changed from `config/solid_queue.yml` to `config/queue.yml`.
4+
- Recurring tasks are now defined in `config/recurring.yml` (by default). Before, they would be defined as part of the _dispatcher_ configuration. Now they've been upgraded to their own configuration file, and a dedicated process (the _scheduler_) to manage them. Check the _Recurring tasks_ section in the `README` to learn how to configure them in detail. They still follow the same format as before when they lived under `dispatchers > recurring_tasks`.
55

66
# Upgrading to version 0.8.x
77
*IMPORTANT*: This version collapsed all migrations into a single `db/queue_schema.rb`, that will use a separate `queue` database. If you're upgrading from a version < 0.6.0, you need to upgrade to 0.6.0 first, ensure all migrations are up-to-date, and then upgrade further.

lib/generators/solid_queue/install/USAGE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ Example:
66

77
This will perform the following:
88
Adds solid_queue db schema
9+
Adds default configurations
910
Replaces Active Job's adapter in environment configuration
1011
Installs bin/jobs binstub to start the supervisor

lib/generators/solid_queue/install/install_generator.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ class SolidQueue::InstallGenerator < Rails::Generators::Base
44
source_root File.expand_path("templates", __dir__)
55

66
def copy_files
7-
template "config/solid_queue.yml"
7+
template "config/queue.yml"
88
template "db/queue_schema.rb"
99
template "bin/jobs"
1010
chmod "bin/jobs", 0755 & ~File.umask, verbose: false

lib/solid_queue/configuration.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def instantiate
2222
concurrency_maintenance_interval: 600
2323
}
2424

25-
DEFAULT_CONFIG_FILE_PATH = "config/solid_queue.yml"
25+
DEFAULT_CONFIG_FILE_PATH = "config/queue.yml"
2626
DEFAULT_RECURRING_SCHEDULE_FILE_PATH = "config/recurring.yml"
2727

2828
def initialize(**options)
File renamed without changes.

0 commit comments

Comments
 (0)