Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

1. Review the release notes and upgrade guide

Check the release notes for anything you think would impact your users.

...

The table below lists R4J versions that require preparation. Versions not NOT listed here are safe to upgrade or downgrade as needed.

R4J version

Upgrade guide

Supporting articles / Important notes

https://easesolutions.atlassian.net/wiki/spaces/REQ4J/pages/edit-v2/2391474179?draftShareId=be52ec51-5ae1-4304-b77d-76a108133ee0

The following template language is not compatible w/ lower versions:

4.16

The following new features are not compatible w/ lower versions:

  • New configuration for coverage formula calculation

  • New persisted display fields for tabular and tree view

4.15

Old permissions are still supported in this version along with new permissions.

The new permissions are not compatible to lower versions.

4.8.0

https://easesolutions.atlassian.net/wiki/spaces/REQ4J/pages/2186969089/Configuration#Number-of-levels-expandable-in-tree

4.7.0, 4.7.1

Migrating the R4J tree data

Breaking change: Tree view data after the migration are not compatible to lower versions.

R4J 4.6.x vs 4.7.x performance benchmark results

Loading issues and errors encountered after tree data migration

https://easesolutions.atlassian.net/wiki/spaces/REQ4J/pages/2186969089/Configuration#Minimum-free-needed-memory-to-process-coverage

4.6.0

“Expand all“ is removed. The feature comes back at 4.8.0.

4.5.0

Cleaning up the R4J revision history data

Breaking change: Revision data from this version are not compatible to lower versions.

Summary of functions affected by revisions restructure in R4J 4.5

4.0.0

Breaking change: Coverage view filters modified and created from this version are not supported in lower versions.

Coverage view filter migration. Already EOL. If further support is needed, contact our service desk.

2. Test the R4J version upgrade using a test or staging instance

Based on your reviews done, do a quick check how the plugin works on your test and/or staging instance.

We strongly recommend to have having a test or staging instance setup, which is as similar as possible to your production instance. This includes server and database configuration and properties, user/admin permissions, as well as a copy of the production data.

3. Plan tasks for the upgrade outside of business hours

Third-party plugins may have some effect to other plugins or Jira itself. For any upgrade, it’s safest to always plan outside of business hours in case anything goes wrong.

4. Backup your instance data

You should have an up-to-date backup to allow you to roll back the database in the very unlikely event that some sort of data corruption results from the upgrade.

5. Perform the R4J version upgrade in your production instance

Info

It is important to do a quick test of the upgrade on your production instance. Based on the results, finalize your decision to remain with the version or rollback roll back to a backward compatible version.

6. Execute R4J Integrity Checker after upgrading

Info

This is an optional but recommended step. This will help to fix data integrity issues after upgrading, if any. Refer to Checking the Database Integrity.