diff --git a/CONTAINERS.md b/CONTAINERS.md index ceee2b7bca..db9160971a 100644 --- a/CONTAINERS.md +++ b/CONTAINERS.md @@ -191,7 +191,7 @@ We publish several Hyrax images to the [GitHub container registry][ghcr] under the [Samvera organization][samvera-packages]. To build them: ```sh -export HYRAX_VERSION=v4.0.0 # or desired version +export HYRAX_VERSION=v5.0.0.rc1 # or desired version git checkout hyrax-$HYRAX_VERSION docker build --target hyrax-base --tag ghcr.io/samvera/hyrax/hyrax-base:$(git rev-parse HEAD) . diff --git a/documentation/developing-your-hyrax-based-app.md b/documentation/developing-your-hyrax-based-app.md index 3e014ebd6b..62b533c5ef 100644 --- a/documentation/developing-your-hyrax-based-app.md +++ b/documentation/developing-your-hyrax-based-app.md @@ -30,7 +30,7 @@ A Hyrax-based application includes lots of dependencies. We provide a [Docker im You can also try [Running Hyrax-based application in local VM](https://github.com/samvera/hyrax/wiki/Hyrax-Development-Guide#running-hyrax-based-application-in-local-vm) which uses Ubuntu. This document contains instructions specific to setting up an app with __Hyrax -v4.0.0.rc1__. If you are looking for instructions on installing a different +v5.0.0.rc1__. If you are looking for instructions on installing a different version, be sure to select the appropriate branch or tag from the drop-down menu above. @@ -105,11 +105,11 @@ Starting up Redis will depend on your operating system, and may in fact already ## Rails -Hyrax requires Rails 5. We recommend the latest Rails 5.2 release. +Hyrax requires Rails 6. We recommend the latest Rails 6.1 release. ``` # If you don't already have Rails at your disposal... -gem install rails -v 5.2.6 +gem install rails -v 6.1.7.6 ``` ### JavaScript runtime @@ -125,7 +125,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app. Generate a new Rails application using the template. ``` -rails _6.1.7.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v4.0.0.rc1/template.rb +rails _6.1.7.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v5.0.0.rc1/template.rb ``` Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including: @@ -223,7 +223,7 @@ You may wish to [customize your work type](https://github.com/samvera/hyrax/wiki ### Enable notifications -Hyrax 2 uses a WebSocket-based user notifications system, which requires Redis. To enable user notifications, make sure that you have configured ActionCable to use Redis as the adapter in your application's `config/cable.yml`. E.g., for the `development` Rails environment: +Hyrax 2+ uses a WebSocket-based user notifications system, which requires Redis. To enable user notifications, make sure that you have configured ActionCable to use Redis as the adapter in your application's `config/cable.yml`. E.g., for the `development` Rails environment: ```yaml development: @@ -231,14 +231,6 @@ development: url: redis://localhost:6379 ``` -Using Rails up to version 5.1.4, ActionCable will not work with the 4.x series of the `redis` gem, so you will also need to pin your application to a 3.x release by adding this to your `Gemfile`: - -```ruby -gem 'redis', '~> 3.0' -``` - -And then run `bundle update redis`. - Note that the Hyrax Management Guide contains additional information on [how to configure ActionCable in production environments](https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide#notifications). ## Managing a Hyrax-based app diff --git a/documentation/legacyREADME.md b/documentation/legacyREADME.md index 5ad396c02b..61cca73545 100644 --- a/documentation/legacyREADME.md +++ b/documentation/legacyREADME.md @@ -1,6 +1,8 @@ # Legacy README -This is a deprecated document that might have some useful information. +## Deprecated Document + +This is a deprecated document that might have some useful information. **It is no longer being updated.** # Table of Contents diff --git a/lib/hyrax/version.rb b/lib/hyrax/version.rb index 447943d18a..4a046bda00 100644 --- a/lib/hyrax/version.rb +++ b/lib/hyrax/version.rb @@ -1,4 +1,4 @@ # frozen_string_literal: true module Hyrax - VERSION = '4.0.0' + VERSION = '5.0.0.rc1' end diff --git a/template.rb b/template.rb index e078162aea..137d2b453e 100644 --- a/template.rb +++ b/template.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true # Hack for https://github.com/rails/rails/issues/35153 gsub_file 'Gemfile', /^gem ["']sqlite3["']$/, 'gem "sqlite3", "~> 1.3.0"' -gem 'hyrax', '4.0.0' +gem 'hyrax', '5.0.0.rc1' run 'bundle install' generate 'hyrax:install', '-f'