Updating and Upgrading

Whether you update S/Notify or Jira or Confluence or Bitbucket, we recommend that you always verify the installation again after any updates by clicking Get started afterwards as explained in step 4 of the installation instructions.

How To Update S/Notify

When updating S/Notify, remember that you must also update the mailer library. To perform a complete update:

On Jira

Stop Jira
Remove the old mailer library
sudo rm <YourJiraInstallationDirectory>/atlassian-jira/WEB-INF/lib/net.savignano.s-notify.*
Download and install the new mailer library (same way as for an initial install, see Step 2: Download and install the S/Notify library component of Installation - S/Notify for Jira)
Start Jira
Update the UI component of S/Notify using Jira's standard mechanism from Manage apps in the Jira Administration menu

On Confluence

Stop Confluence
Remove the old mailer library
sudo rm <YourConfluenceInstallationDirectory>/confluence/WEB-INF/lib/net.savignano.s-notify.*
Install the new mailer library (same way as for an initial install, see Step 2: Download and install the S/Notify library component of Installation - S/Notify for Confluence)
Start Confluence
Update the S/Notify app using Confluence's standard mechanism from Manage apps in the Confluence administration menu

On Bitbucket

Stop Bitbucket
Remove the old mailer library
sudo rm <YourBitbucketInstallationDirectory>/app/WEB-INF/lib/net.savignano.s-notify.*
Install the new mailer library (same way as for an initial install, see Step 2: Download and install the S/Notify library component of Installation - S/Notify for Bitbucket)
Start Bitbucket
Update the S/Notify app using Bitbucket's standard mechanism from Manage apps on the Bitbucket main administration page

Version Numbers

S/Notify tries to follow the https://semver.org/ specification, meaning that the version numbers of our releases are made up of three numbers MAJOR.MINOR.PATCH where

MAJOR version changes are made when significant new features are introduced. Usually, these new features are visible to the user, but occasionally they may just be significant improvements under the hood. Changes may include breaking changes, but if so, this will be clearly stated in the release notes.
MINOR version changes are made when new features or improvements (or both) are introduced, which should be fully backward-compatible.
PATCH versions do not include any new features or improvements, but only fixes of what we have considered unintended behavior (commonly referred to as bugs).
PATCH versions continue to support the same minimum version of the Atlassian platform, even if it has reached end of life, to make sure they can be used to update previous PATCH versions.

MAJOR and MINOR versions may always also include bug fixes.

Updating Jira

Using the Standard Jira Installer

When you use the standard Jira installer to update your Jira instance to a newer version, note that the installer usually replaces all third-party libraries in <YourJiraInstallationDirectory>/atlassian-jira/WEB-INF/lib.

Therefore, after the update, check if the net.savignano.snotify.jira.mailer* jar has been removed. If so, please re-install it as described in Step 2: Download and install the S/Notify library component of Installation - S/Notify for Jira)

Updating Confluence

Using the Standard Confluence Installer

When you use the standard Confluence installer to update your Confluence instance to a newer version, note that the installer usually replaces all third-party libraries in <YourConfluenceInstallationDirectory>/confluence/WEB-INF/lib.

Therefore, after the update, check if the net.savignano.snotify.confluence.mailer* jar has been removed. If so, please re-install it as described in Step 2: Download and install the S/Notify library component of Installation - S/Notify for Confluence.

Updating Bitbucket

Using the Standard Bitbucket Installer

When you use the standard Bitbucket installer to update your Bitbucket instance to a newer version, note that the installer usually replaces all third-party libraries in <YourBitbucketInstallationDirectory>/app/WEB-INF/lib.

Therefore, after the update, check if the net.savignano.snotify.bitbucket.mailer* jar has been removed. If so, please re-install it as described in Step 2: Download and install the S/Notify library component of Installation - S/Notify for Bitbucket.

Multi-Node Data Center Instances

Note that on Data Center instances run on multiple nodes, you should be aware of the following particularities.

Coupling

As an administrator, you should be aware that S/Notify consists of two components

the GUI component which you can install and update via the Manage apps Administration panel
the mailer library component which needs to be installed manually to the WEB-INF/lib folder on all nodes

The two components are loosely coupled, so it is possible to update them in two separate steps. However, note that S/Notify will issue warnings on its configuration panels when it detects that the components have different versions.

Compatibility

As a rule, newer versions of S/Notify will come backward compatible with previous versions of S/Notify. What we mean by backward compatibility:

Existing features will usually continue to work as configured in previous versions
New features will usually come with a default configuration that complies with the behavior in previous versions
Occasionally, there might be a reason to deviate from the above rules, but in this case, the release notes will list any incompatibilities

Therefore, before you update S/Notify, you should check the release notes.

Recommendations

Updating S/Notify

As a rule, if you cannot update both components at the same time, we recommend that you update the GUI component first (by updating the app from Manage apps in the Administration panel), because then you can configure the behavior of new features to suit your needs before they become activated by installing the mailer library component.

Bundled Updates

If you want to update S/Notify at the same time as the Jira or Confluence instance it is running on, be sure to check our Known Limitations page before you plan the update. Usually, the latest releases of S/Notify should be compatible with newer release of Jira and Confluence, but to be safe, always check if any known issues are listed on that page.