Skip to content

Commit f0b948e

Browse files
Merge pull request #8915 from tknippenberg/SemVer
Explained semantic version
2 parents 940e7f3 + e84ae0d commit f0b948e

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,20 +63,31 @@ Solution modules are only used for developing a solution and are an inseparable
6363

6464
When the module is set as the solution module, it gets the letter **S** as an icon.
6565

66-
### Module Version
66+
### Module Version {#module-version}
6767

6868
{{% alert color="info" %}}
6969
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.
7070
{{% /alert %}}
7171

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.
7373

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.
7575

7676
{{% alert color="info" %}}
7777
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.
7878
{{% /alert %}}
7979

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*.
90+
8091
## Package {#package}
8192

8293
{{% alert color="info" %}}

0 commit comments

Comments
 (0)