Upgrade to v8

The purpose of this note is to help developers to upgrade their agent from v7 to v8. Please read carefully and integrate the following breaking changes to ensure a smooth update.​

Upgrade to v8

Please follow the recommended procedure to upgrade your agent version by following this note.

This upgrade unlocks the following features:

  • Use templating in the filters of Chart components

  • Add conditions to your role permissions

Upgrading to v8

To upgrade to v8, first update your project according to the Breaking Changes section below.

If you're upgrading from an older version, please make sure you've also read the previous upgrade notes (v7, v6,..)

To upgrade to v8, update the version in your Gemfile, then run the following and update your project as shown in the Breaking Changes section below.

bundle install

In case of a regression introduced in Production after the upgrade, a rollback to your previous agent version 7 is the fastest way to restore your admin panel.

Breaking changes

Roles v2.0

This new version (v8) drops the support of the legacy Roles system (v1.0). If you are this legacy configuration, please follow this procedure in order to migrate to the new Roles system (v2.0) before you attempt to upgrade to version 8.

Approval Workflow

Whether or not your project currently uses the Approval Workflow feature, you must ensure that all your Smart Actions controllers extend from the ForestLiana::SmartActionsController controller.

controller.rb
# NOW in v9, this configuration is mandatory to make approvals work as expected.
class Forest::CompaniesController < ForestLiana::SmartActionsController
  def mark_as_live
    # ...
  end
end

Routes override

If your project overrides routes, using the ForestLiana::PermissionsChecker to check the permissions, you must replace PermissionsChecker.new(...) by ForestLiana::Ability::forest_authorize!(action, forest_user, @resource).

An example can be found here.

Last updated

Was this helpful?