Cypress 3.x Upgrade Instructions

These instructions are for Cypress v3 which is not the latest version of Cypress. For Cypress v4, please see our updated instructions.

Install Clean Version of Cypress v3.2.3

Follow the Cypress V3 Install Instructions if you do not already have a running version of Cypress v3.0.x.

Upgrade Existing Version of Cypress V3.x.x to V3.2.3

Connect to your machine running cypress and run the following command:

curl https://raw.githubusercontent.com/projectcypress/cypress/v3.2.3/contrib/upgrade_cypress_32.sh | sudo bash

Upgrade Caveats

• If the command seems hung, double check that it is not just waiting for your password. If you see [sudo] password for username: then type your password and hit enter and it will begin executing the updater. *If you see the message WARNING: Unable to merge cypress config cleanly, you will need to manually reset your settings in /opt/cypress/config/cypress.yml manually or through the admin control panel., please do not ignore it. This means the upgrade script had to reset the settings saved in cypress.yml due to a conflict between your settings and the settings file that is provided with cypress. In this case please take a look at the file located at the path provided and make sure the settings are correct for your environment.
• Sometimes you may be prompted with a screen informing you of a modified configuration file (as follows)
  In this case please make sure you take special care to properly merge these files. If you do not you will end up with some settings which you previously have set in Cypress reset to their default state. You will want to first note the path to the file which will be written at the top of the prompt (The path will normally be either /opt/cypress/config/cypress.yml or /home/cypress/cypress/config/cypress.yml). Next you will choose the option to show the differences between the versions. Once you have made note of the changes you will normally want to install the package maintainer's version and then edit the file by hand or using the cypress application to reset the options required by your specific use case.
• If you are receiving Internal Server Errors after upgrading, please check to make sure your default bundle is set, as it may be unset by the issue listed above.