Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prep 5.0.0.rc1 #6224

Merged
merged 1 commit into from
Aug 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) .
Expand Down
18 changes: 5 additions & 13 deletions documentation/developing-your-hyrax-based-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -223,22 +223,14 @@ 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:
adapter: redis
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
Expand Down
4 changes: 3 additions & 1 deletion documentation/legacyREADME.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion lib/hyrax/version.rb
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# frozen_string_literal: true
module Hyrax
VERSION = '4.0.0'
VERSION = '5.0.0.rc1'
end
2 changes: 1 addition & 1 deletion template.rb
Original file line number Diff line number Diff line change
@@ -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'