Learn about general support and maintenance recommendations for customizations
Release process
CHANGELOG.md
file and in the GitHub release pages in the following repositories:All published packages to NPM are listed in the following scoped packages:
Release cadence
commercetools strives to continuously improve the tooling and packages related to Merchant Center customizations. We do not follow a strict release cycle. Instead, we publish releases in meaningful intervals, potentially multiple times a week. Minor and patch versions are released more frequently than major versions.
Breaking changes
v1
to v2
.How a breaking change can impact your customization:
- It affects a component or module not used within the customization
- It affects a component or module used within the customization
- It affects a component or module directly interacting with some of commercetools's internal APIs
A new major release does not always mean that breaking changes directly affect consumers of the packages. Some examples are:
- A dependency package drops support for an older Node.js version, thus releasing a major version. As a result, commercetools could subsequently release a new major version to also drop support for the Node.js version. However, this is unlikely to affect consumers of Custom Application or Custom View packages.
- React releases a new feature that requires a specific minimum version. As a result, commercetools could subsequently release a new major version, updating the minimum React version requirement for Custom Applications or Custom Views.
Minimum required maintenance policy
All built-in Merchant Center applications are kept up-to-date with the released tools and packages. This ensures the uniform adoption of the latest bug fixes and features across all applications.
We recommend that customizations are updated at regular periods and maintained in planned intervals, to avoid falling too many versions behind. Failure to do so may lead to increased maintenance efforts if the codebase requires updates across multiple versions, especially for major releases and/or deprecated API functionalities.
Automate maintenance of dependencies
These tools and services can be configured to meet a wide range of needs, for example, to get updates only once a week.
Hosting
Customers using Custom Applications or Custom Views are responsible for the maintenance, hosting, and deployment of the customization(s). commercetools does not take any responsibility for incidents and/or service disruptions related to customizations which are caused by their underlying infrastructure.
Issues and support requests
Contributing
commercetools provides all packages and tools under the open-source MIT license.
At commercetools, we love open source and actively contribute to other open source software that we also use internally. As such, we welcome contributions to our packages, whether in the form of an issue or a pull request.
You can read more about the contribution guidelines in the following repositories: