Skip to content

Releases: samvera/hyku

v6.0.0

11 Jul 20:46
@kirkkwang kirkkwang
v6.0.0
d453b24
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v6.0.0 Latest
Latest

What's Changed

Breaking Changes 🛠

Exciting New Features 🎉

Bug Fixes 🐞

Other Changes

  • Revert "knapsack gemfile additions or replacement" by @jeremyf in #2151

Full Changelog: v5.1.0...v6.0.0

Contributors

jeremyf, orangewolf, and 5 other contributors
Assets 2
Loading

v6.0.0.rc3

02 Apr 17:00
@kirkkwang kirkkwang
v6.0.0.rc3
ca49a19
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v6.0.0.rc3 Pre-release
Pre-release

What's Changed

Breaking Changes 🛠

Exciting New Features 🎉

Bug Fixes 🐞

Other Changes

  • Revert "knapsack gemfile additions or replacement" by @jeremyf in #2151

Full Changelog: v5.1.0...v6.0.0.rc3

Contributors

jeremyf, orangewolf, and 4 other contributors
Assets 2
Loading

v6.0.0.rc1

09 Jan 15:18
@jeremyf jeremyf
v6.0.0.rc1
31fb129
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.
Compare
Choose a tag to compare
v6.0.0.rc1 Pre-release
Pre-release

What's Changed

Breaking Changes 🛠

Bug Fixes 🐞

Full Changelog: v5.1.0...v6.0.0.rc1

Contributors

ShanaLMoore, kirkkwang, and aprilrieger
Assets 2
Loading

v5.1.0

30 Nov 00:55
@orangewolf orangewolf
v5.1.0
3362868
Compare
Choose a tag to compare
v5.1.0

What's Changed

Exciting New Features 🎉

Bug Fixes 🐞

Other Changes

New Contributors

Full Changelog: v5.0.1...v5.1.0

Contributors

jeremyf, orangewolf, and 10 other contributors
Assets 2
Loading

v5.0.1

24 Feb 18:05
@bkiahstroud bkiahstroud
v5.0.1
3831eac
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.
Compare
Choose a tag to compare
v5.0.1

What's Changed

Bug Fixes 🐞

Full Changelog: v5.0.0...v5.0.1

Contributors

orangewolf and bkiahstroud
Assets 2
Loading

v5.0.0

06 Feb 17:44
@bkiahstroud bkiahstroud
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.
Compare
Choose a tag to compare
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 🛠

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
Loading

v4.0.0

09 May 22:55
@orangewolf orangewolf
v4.0.0
ee1e289
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.
Compare
Choose a tag to compare
v4.0.0

This release adds several large features (Cross Site Search, Custom Themes, Multiple Domains Per Tenant and Private Tenant Support) along with a substantial overhaul in to how settings are managed. This is packaged along with quite a few bug fixes and improvements.

Please see the Migrations section below.

Features

Cross Site Search

Hyku now has the ability to create search only tenants. A search only tenant searches 1 or more other tenants and displays results from all of them in a unified interface. These tenants are manageable in the admin interface. This work was contributed as part of the Advancing Hyku Project done by Ubiquity Press with special thanks to @mankind for the majority of this code. The British Libraries sponsored work for Notch8 to integrate the cross site search and the new settings UI in to Hyku's main repository. You can see a basic demo of this feature here https://share.getcloudapp.com/RBunGOYP

Theming

Hyku now ships with 3 custom home page themes, 2 custom show page themes and 2 search results themes. There is a new tab on the admin dashboard (settings/appearance) which allows admins to select themes. This opens the door for additional themes to be developed that include custom views, css and javascript. This change also add feature flags for Featured Researcher, Recently uploaded, Featured Works, Share your work button. This work was sponsored by the Hyku for Consortia project from PALNI and PALCI, under their IMLS grant, "Scaling Up a Collaborative Consortial Institutional Repository." This presentation from Samvera Virtual Connect 2021 provides an excellent walk-through of this functionality. Detailed instructions on adding and selecting themes are provided at the links below:

Support Multiple Domains per Tenant

Previously only one domain name could point at a given tenant. We now support multiple domain names and make adding additional domains available from the UI. For example both samvera.hykuup.com and repo.samvera.org can render the same content.

Private Tenant Support

Tenants can be marked as private in the proprietor UI. Doing so prevents them from being listed on any public facing list of accounts and puts a simple http basic auth in front of the site. This allows for underdevelopment accounts to be set up with out being public or being indexed by search engines and prevents the public from wandering in to demo or staging sites.

Featured Collections

Users previously could not specify which collections they wanted to appear on the homepage, and collections appeared in order of whichever was the most recently added. There was also no way to prevent a collection from appearing on the homepage besides making it private. Hyku now utilizes the code for Featured Works, and adapts it so that users can select, feature and reorder whichever collections they would like to show on the homepage.

Use Hyrax Docker / Helm Base Setup

Hyrax now provides a minimal base docker image, intended to be reused and extended by applications. this is a proposal to replace the existing Dockerfile with one based on that image.

this would switch the application server to puma. our thinking is that real containerized deployments (e.g. via the Helm chart) are likely to be behind a load balancer and an nginx (an ingress controller).

the image is kept minimal with the idea that a smaller set of system dependencies means a lower footprint for security risks, besides the bandwidth and storage convenince. Hyrax's setup definitely has space to improve here, but the idea is greater consolidation will help the community maintain something really solid.

This release removes the custom chart code that Hyku was maintaining, but few if any people were using.

Settings and Configuration Overhaul

Configuration settings were available in too many places and with too many names. In order to consolidate and modernize this approach the following refactoring has been done. All "global" configuration now happens in ENV vars. The ruby-config gem has been removed and settings in config/settings.yml, `config/settings/production.yml', etc are completely removed in this version. The ENV vars have been updated to match Hyrax and Rails standards wherever possible. See # Migration Instructions for more information on updating your application.

A new settings interface was added to the account. This interface allows for tenants to override settings in their admin UI or in the proprietor UI where appropriate. Setting specified at the account level can have a specified default. The precedence is that if a settings value is set that is used. If not, and an ENV var matches, then the ENV var is used. If not and a default is coded in, then the default is used. Lastly if none of those 3 are true, the value is nil.

Special thanks to Ubiquity for doing the initial implementation on this feature and to the British Library to supporting Notch8's work to extract it in to Hyku and expand its scope.

Make Account Switching Simpler

Previously switch accounts was accomplished in the console or in scripts by called AccountElevator.switch!(CNAME). This is still supported, but becomes tedious due to how frequently switching tenants is needed. Devs can now call switch!(X) where X is any of the following:

  • Account object
  • cname
  • name of an account object

This changed also allowed us to consolidate several code paths which previously handled account switching.

Bugs

  • Disabling a work type causes errors
  • Update links for Samvera wiki move
  • Remove coveralls gem from CI, it was flaky and no longer helpful
  • Set default scope for users to exclude guests, remove old guests (#1720)
  • Non-ACL file system support. Azure and other network file systems do not support setting file permissions. This sets up a flag to disable file permission setting if needed
  • Don't try to assign registered role on global tenant (#1712)
  • Branding images should be served from public, not tmp
  • Move dory domain to .test since Google is resolving .docker now
  • Solve issue where apartment initializer would not allow migrations before seeds had been run

Migration Instructions

This is a major release. There are several database migrations to run, but more importantly there are major changes to the way settings are handled. All items previously controlled via the ruby config gem are now controlled via either environment variables or in tenant settings. Environment variable names have been remapped to match Hyrax where possible, simplified where possible and to clearly distinguish them where not possible.

For example:
SETTINGS__SOLR__URL (or the solr url field in the settings.yml file) is now SOLR_URL
SETTINGS__JOB__QUEUE is now HYRAX_ACTIVE_JOB_QUEUE.

Settings set at the tenant level will override their environment set defaults. See https://github.com/samvera/hyku/blob/main/app/models/concerns/account_settings.rb and the README for examples of available variables.
The development environment is also more closely aligned with Hyrax, but most of these changes are abstracted under the Docker configuration.

Contributors

mankind
Assets 2
Loading

v3.0.2

14 Apr 18:44
@orangewolf orangewolf
v3.0.2
97e392f
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.
Compare
Choose a tag to compare
v3.0.2

Update to Rails 5.2.5 and fix Mimemagic

This release upgrades to Rails 5.2.5 to fix issues around mimemagic. See this summary for background information. Previous versions will likely be broken without upgrading their Gemfile along with every other Rails application in existence.

Assets 2
Loading

v3.0.1

06 Feb 06:21
@orangewolf orangewolf
v3.0.1
319bf71
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.
Compare
Choose a tag to compare
v3.0.1

Security Patch

This is a single security item patch release. This release, or an upgrade to blacklight-oai-provider >= 6.1.1, is recommended for anyone with blacklight-oai-provider installed. Previous versions of blacklight-oai-provider did not properly check security on GetRecord calls. This could lead to access of a private item, via OAI, if the attacker knew the identifier for that item. This release is otherwise the same as v3.0.0.

Assets 2
Loading

v3.0.0

19 Jan 20:06
@orangewolf orangewolf
v3.0.0
6a7dc2e
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.
Compare
Choose a tag to compare
v3.0.0

This is our first release in over a year. We are increasing the major version do to the user elevation being a breaking change for Hyku consumers who have local (non-sso) based user logins. We don't anticipate this being a massive effort to migrate users, but want to signal clearly to folks that it is something that needs to be done. There are lots of notable features below and our hope is that the next few releases will focus on being smaller, more incremental feature releases and bug fixes.

Features

Theming Improvements

  • Customizable CSS in interface
  • More individual colors
  • Font selection tool
  • Ability to set the default images and logos on a per tenant basis from within the UI

Bulkrax Import and Export

  • Optional dependency behind feature flipper
  • Connected to Browse Everything
  • Status dashboard and individual tenant user self service

Contact page customizable email per tenant

Upgrade to Hyrax 2.9.1, Rails 5.2, Ruby 2.7, removed now redundant code

User management improvements, including elevating the users site wide

  • User management available as superuser
  • Users do not need to register for each tenant enabling Single Sign On functionality
  • Roles remain per tenant
  • Stepping stone to a more comprehensive and solid permissions structure site wide
  • This is a breaking change for anyone with users in individual tenants as those user accounts will need to be migrated out to the 'public' users table before an upgrade to Hyku 3.0. No migration is provided at this time due to no one having a case for it. If you do need help with a migration path for users, please contact us.

Background jobs to automatic embargo release

Local docker development speed improvements using volume caches

Helm chart kubernetes deployment for Hyku

Collection thumbnail path fixes

This release is identical to Pre-release 2 only the version number has been changed to protect the innocent.

Assets 2
Loading