You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md
+14-3Lines changed: 14 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,20 +63,31 @@ Solution modules are only used for developing a solution and are an inseparable
63
63
64
64
When the module is set as the solution module, it gets the letter **S** as an icon.
65
65
66
-
### Module Version
66
+
### Module Version {#module-version}
67
67
68
68
{{% alert color="info" %}}
69
69
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.
70
70
{{% /alert %}}
71
71
72
-
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/).
72
+
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.
73
73
74
-
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.
74
+
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.
75
75
76
76
{{% alert color="info" %}}
77
77
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.
78
78
{{% /alert %}}
79
79
80
+
#### Version format
81
+
82
+
The version should be a semantic version, consisting of at least three numerical parts: major, minor, and patch version, such as *1.3.7*.
83
+
Refer to the following guidance when changing the version number:
84
+
85
+
* 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.
86
+
* 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.
87
+
* 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.
88
+
89
+
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*.
0 commit comments