diff --git a/content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md b/content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md index 6e69b4a6894..c18d3059c4d 100644 --- a/content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md +++ b/content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md @@ -63,20 +63,31 @@ Solution modules are only used for developing a solution and are an inseparable When the module is set as the solution module, it gets the letter **S** as an icon. -### Module Version +### Module Version {#module-version} {{% alert color="info" %}} Version is available for all module types for Studio Pro 11.12 and above. In earlier versions of Studio Pro, version is available only for add-on and solution module types. {{% /alert %}} -This is the version number of the module. The version should be a semantic version, consisting of at least three parts: major, minor, and patch version. For more information on semantic versions, see [Semantic Versioning](https://semver.org/). +This is the version number of the module which is shown in various places in the Studio Pro user interface, as well as in the Marketplace. -Mendix recommends setting a new version every time you make changes to the module. For modules that will be published to the Marketplace, the version must be set before exporting the package. +When redistributing a module, you should always change the version number when changes are made. For modules that will be published to the Marketplace, the version must be set before exporting the package. {{% alert color="info" %}} The Marketplace automatically uses the version from the exported package. You cannot change this manually. If the version is already in use, the Marketplace rejects the package. {{% /alert %}} +#### Version format + +The version should be a semantic version, consisting of at least three numerical parts: major, minor, and patch version, such as *1.3.7*. +Refer to the following guidance when changing the version number: + +* Increase the major version when making breaking changes, such as removing a functionality like an entity or a microflow, or upgrading the module to a new major version of Studio Pro. +* Increase the minor version when adding new features in a backward compatible manner. For example, when adding a microflow or entity that do not interfere with existing behavior. +* Increase the patch version when making backward compatible bug fixes, such as fixing a styling issue on a page or changing a calculation in a microflow without changing the parameters and output type. + +Next to the numerical major, minor and patch version, alphanumerical characters are allowed. This is considered to be an advanced feature, for more information, please see [Semantic Versioning](https://semver.org/). An example of an advanced version number is *1.3.7-beta.2*. + ## Package {#package} {{% alert color="info" %}}