Updating River

To keep third party dependencies as self-contained as possible, River is distributed as a set of interrelated Go Modules. Normally when fetching the top level github.com/riverqueue/river Go will resolve new versions of other modules as it needs to, but especially when working with new releases, it may accidentally find incompatible versions.

For best results, it’s recommend that all River-related modules be updated simultaneously using a single invocation of go get:

RIVER_VERSION=latest;

go get -u github.com/riverqueue/river@$RIVER_VERSION \
        github.com/riverqueue/river/cmd/river@$RIVER_VERSION \
        github.com/riverqueue/river/riverdriver@$RIVER_VERSION \
        github.com/riverqueue/river/riverdriver/riverdatabasesql@$RIVER_VERSION \
        github.com/riverqueue/river/riverdriver/riverpgxv5@$RIVER_VERSION \
        github.com/riverqueue/river/riverdriver/riversqlite@$RIVER_VERSION \
        github.com/riverqueue/river/rivershared@$RIVER_VERSION \
        github.com/riverqueue/river/rivertype@$RIVER_VERSION && \
    go mod tidy

Chaining go mod tidy makes sure that any drivers that weren’t in use by the project are stripped back out again.

Update the core gem and the driver gems in the same Bundler operation:

bundle update riverqueue riverqueue-sequel

Substitute riverqueue-activerecord when using Active Record. Commit the updated lockfile and run migrations before starting the updated workers.

Update River’s crates together within the version requirements in Cargo.toml:

cargo update -p riverqueue

For a new version outside those requirements, update Cargo.toml first. Keep optional riverqueue-test and riverqueue-migrate dependencies compatible with the core crate. Update a separately installed CLI with cargo install riverqueue-cli --locked.

Update the River packages your application uses together:

npm install riverqueue@latest @riverqueue/driver-pg@latest @riverqueue/migrate@latest
npm install --save-dev @riverqueue/cli@latest @riverqueue/test@latest

Include other River drivers or extensions you use and keep their versions aligned. Commit the updated lockfile.