Skip to content

Upgrade guide

Jason Rosa edited this page Feb 1, 2021 · 4 revisions

Each new release for the HubSpot CMS Boilerplate will include detailed notes on features that were added and bugs that were fixed (for example here is the release for version 1.2 of boilerplate). To see changes that were made since your last boilerplate update, we'd recommend:

  1. Going to the releases page of the repository.
  2. Comparing the difference between your project’s version with the most recent boilerplate release.
  3. Pulling in the pieces of code from each release that you want included in your project. As the HubSpot CMS Boilerplate is intended to serve as a starting point for your projects, feel free to only pull in the updates that are relevant and helpful for your particular project.

If a major version is released, we will include specifics on what the breaking changes are and how to account for them on existing projects in the release notes. Please note that some major version updates may not have an easy upgrade path and will require additional work to implement. There may also be scenarios where the implementing major version updates on an existing project may not be possible without making a breaking change.

Important note for marketplace providers: It is very important to consider breaking changes when updating your marketplace theme. A breaking change is anything that would change live content on a theme. Some examples of this include:

  • Changing the default CSS for a theme in a way that would change live content
  • Changing the HTML/CSS of a module within the theme in a way that would change live content
  • Changing the JavaScript on a theme in a way that would change live content
  • Removing theme or module fields in a way that would change live content

If you introduce a breaking change when updating your theme, this could result in your customer's website changing unexpectedly or breaking when they upgrade their theme to pull in the most recent changes.

Clone this wiki locally