Theme Updates and Version Control

When developing BigCommerce themes, there are a few steps you can take to ensure your custom theme stays up to date with BigCommerce theme updates and version releases.

Version Control

A typical setup might include a base theme, with several custom themes branching from the base theme. The custom theme(s) will need to be kept up to date with any major changes while maintaining its own customizations. Version control systems such as Git can help ensure themes stay up to date. For example, you can place the parent theme on the master branch and keep each child theme on its own separate branch. Changes to the master theme can then be pushed to each child if needed.


Theme Updates

If you are using a Cornerstone theme as your base theme, update notifications are found in our changelog. If you are using another theme, please see the theme creator for updates.

Before updating your theme, review the following list items to ensure a successful update:

  • Create a backup of the custom theme.
  • Keep a backup of config.json. This file contains all the configurations and many of the customizations for a theme.
  • Never merge an update directly into your custom theme.
  • Test any new updates before pushing the updates to production. A good way to do this is to keep a test theme that mirrors your theme in production and apply any new changes to the test theme. If there are no issues, apply your updates to production.

Maintaining Customizations

When creating customizations, it’s important to create a new file to overwrite the original styles, as opposed to modifying the original existing file. For example, {{{stylesheet ‘/assets/css/theme.css’}}} is the file that has the CSS that already exists in the theme. Instead of making edits to this file, create a new .css file, such as {{{stylesheet ‘/assets/css/my_custom_theme.css’}}}. Place your new styles in this file, and reference this file in the layouts.

Make sure to discuss with the merchant not to make any changes to the files. This can cause issues later on with updates. Having multiple editors to files could potentially cause issues later on with updates if a proper workflow is not established.


References