v5.0.0
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 🛠
- Upgrade to Hyrax 3.5.0 by @orangewolf in #1907
- Upgrade to Hyrax 3.4.0 by @orangewolf in #1811
- Groups with Roles feature by @bkiahstroud in #1859
- Use main docker images for zookeeper and solr for development. by @orangewolf in #1809
- uv not rendering by @ShanaLMoore in #1829
- align-fcrepo-variables-to-hyrax by @aprilrieger in #1878
- make env vars consistent by @ShanaLMoore #1831
- removing-lingering-settings-envs by @aprilrieger #1832
Exciting New Features 🎉
- add-pagination-to-proprietor-account-show-tables by @aprilrieger in #1798
- add favicon uploads to appearance dashboard (#313) by @labradford in #1868
- add filesets to search for collection show page by @labradford in #1876
- add-google-analytics by @aprilrieger in #1882
- Contributing back negative captcha by @aprilrieger in #1877
Bug Fixes 🐞
- fix single tenant catalog links by @orangewolf in #1801
- Fix shared search links by @laritakr in #1823
- 83 datacite endpoint credentials save error by @selamhabteab in #1824
- Resolved mixed content error due to insecure XMLHttpRequest endpoint … by @selamhabteab in #1822
- rename fedora_url to fcrepo_url for consistency by @ShanaLMoore in #1827
- Fix Shared Tenant Theme Urls by @laritakr in #1835
- add checked option to radio button by @kirkkwang in #1833
- 1837 better user error handling by @alishaevn in #1838
- contribute_back_i541-featured-works-save by @aprilrieger in #1841
- Fix shared search URLs by @laritakr in #1844
- Move Blacklight URL Helper overrides by @laritakr in #1847
- use same uploader for banner as other items. fix from british library by @orangewolf in #1852
- Fix typos by @cclauss in #1849
- add-clause-to-account-settings-for-google_analytics_id by @aprilrieger in #1845
- Backport fix from UTK by @laritakr in #1861
- Moving ContentBlock methods by @jeremyf in #1853
- moves share your work button outside of featured works partial by @labradford in #1866
- workflow actions header color by @labradford in #1864
- adds libreoffice to Dockerfile by @labradford in #1870
- fix embargo and lease date time issue by @labradford in #1872
- fixes neutral repo home page collections by @labradford in #1874
- Fix sign up link not rendering by @bkiahstroud in #1880
- Remove unnecessary equality check by @bkiahstroud in #1881
- add-worker-script-executable-update-dockerfile-cmd by @aprilrieger in #1843
- disable-analytics-env-also-dont-error-if-not-enabled by @aprilrieger in #1887
- add conditional to account for when iiif print gem is installed by @kirkkwang in #1886
- Image magick and build fixes by @orangewolf in #1900
Dependency updates
- upgrade Hyrax to v3.4.2 by @bkiahstroud in #1855
- Bump jmespath from 1.4.0 to 1.6.1 by @dependabot in #1808
- Bump rack from 2.2.3 to 2.2.3.1 by @dependabot in #1802
- Bump nokogiri from 1.12.5 to 1.13.6 by @dependabot in #1810
- Bump tzinfo from 1.2.9 to 1.2.10 by @dependabot in #1828
- Bump loofah from 2.18.0 to 2.19.1 by @dependabot in #1858
- Bump nokogiri from 1.13.6 to 1.13.10 by @dependabot in #1856
New Contributors
- @ShanaLMoore made their first contribution in #1827
- @alishaevn made their first contribution in #1838
- @cclauss made their first contribution in #1849
Full Changelog: v4.0.0...v5.0.0
