Skip to content

Commit

Permalink
updating the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eddierubeiz committed Jul 14, 2022
1 parent b624826 commit 7731c60
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,13 +152,13 @@ If you're working on PR for this project, create a feature branch off of `main`.
This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct) and [language recommendations](https://github.com/samvera/maintenance/blob/main/templates/CONTRIBUTING.md#language). Please ***do not*** create a branch called `master` for this repository or as part of your pull request; the branch will either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository.

## Compatibility
This code works with the latest versions of:
- Rails 6.1 and 6.0.
- Rails 5 also works with Ruby versions older than 3.
- Ruby 3.0 (except with Rails 5), 2.6, and 2.5.
- The combination of Ruby 3 and Rails 6 comes with two caveats:
This gem works with Rails 5.0-6.1 and Ruby 2.5-3.1, provided the version of Rails supports the version of Ruby.
- Consult `.circleci/config.yml` for a list of supported combinations.
- The combination of Ruby 3.1 and Rails 6.0 comes with three caveats:
- your app will not be able to use `psych 4` (which ordinarily comes with 3.1). See https://bugs.ruby-lang.org/issues/17866 and https://stackoverflow.com/questions/71191685/visit-psych-nodes-alias-unknown-alias-default-psychbadalias/71192990#71192990 for an explanation. One workaround is to modify your app's `Gemfile` to hold back `psych`: `gem 'psych', '< 4'`.
- likewise, you want to add gem 'net-smtp', require: false to your Gemfile to get around the bug described in https://stackoverflow.com/questions/70500220/rails-7-ruby-3-1-loaderror-cannot-load-such-file-net-smtp .
- finally, you may want to opt in to the latest version of "mail". Again, add to your Gemfile the line `gem "mail", ">= 2.8.0.rc1"`.

See also `.circleci/config.yml` and `spec/test_app_templates/Gemfile.extra`.

## Product Owner & Maintenance
Expand Down

0 comments on commit 7731c60

Please sign in to comment.