Skip to content

Explained semantic version #8915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MariaShaposhnikova merged 5 commits into from
Jul 15, 2026
+14 −3
Merged

Explained semantic version #8915

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a480409
Started on documentation
tknippenberg Jan 14, 2025
f134919
Text changes
tknippenberg Jan 14, 2025
e3f17bd
Minor changes
tknippenberg Jan 14, 2025
955e922
Merge remote-tracking branch 'origin/development' into SemVer
tknippenberg Jul 15, 2026
e84ae0d
Review
MariaShaposhnikova Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,20 +63,31 @@

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

Check failure on line 80 in content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Mendix.HeadingTitleCase] Use title case capitalization for 'Version format'.

Raw Output:
{"message": "[Mendix.HeadingTitleCase] Use title case capitalization for 'Version format'.", "location": {"path": "content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md", "range": {"start": {"line": 80, "column": 6}}}, "severity": "ERROR"}

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" %}}
Expand Down