Skip to content

v5.0.0
Compare
Choose a tag to compare
@bkiahstroud bkiahstroud released this 06 Feb 17:44
· 402 commits to main since this release
v5.0.0
a2a0f68
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Migration Procedures from Hyku 4.0 to 5.0

Graph Nested Indexer

We can use Solr graph queries to skip having to do nested indexing. This speeds up adding and editing items to large collections substantially. The only downside is that this method does not work if your Solr Cloud shard size is set to > 1. If you do not use Solr Cloud or if you use the default shard size of 1, this will work wonderfully. If you do need a higher shard size set HYRAX_USE_SOLR_GRAPH_NESTING explictly to false and also open an issue in Hyku as the next version of Hyrax makes Graph Nesting the only option.

Bulkrax is Enabled by Default

It can be disabled by setting the HYKU_BULKRAX_ENABLED environment variable to false, but the gem will still be included in your gem path and the scoped Bulkrax JS and CSS files will still be included unless you manually remove them.

Groups with Roles feature

Please refer to the Setup an Existing Application to use Groups with Roles section in the Groups with Roles Feature Wiki article.

Hyrax Upgrade Changes

The vast majority of Hyrax upgrade issues are simply resolved in Hyku for you with this upgrade. You do need to run rails db:migrate to update your database schema.

However, if you have custom overrides, you should probably review the following to make sure nothing has moved out from under your code.

  • v3.0.0 section titled "Incompatible API Changes"
  • V3.1.0 section titled "Refactors"
  • V3.2.0 section titled "Refactors"

Analytics

New analytics features are enabled in the application. In order to take full advantage of the in application reporting you need to set up a Google API access. See https://github.com/samvera/hyku#analytics-feature for details.

Environment variable changes

Several environment variables have changed names to more closely align with Hyrax and to remove redundancy. Checking any deployment scripts or .env files against the current list in the README is advised.

What's Changed

PURL and and CSV importers are deprecated

The built in PURL and CSV command line importers are supplanted Bulkrax feature wise. They have not been maintained and will are expected to be removed in the next release.

Breaking Changes 🛠

Exciting New Features 🎉

Bug Fixes 🐞

Dependency updates

New Contributors

Full Changelog: v4.0.0...v5.0.0

Contributors

jeremyf, orangewolf, and 10 other contributors
Assets 2