-
Notifications
You must be signed in to change notification settings - Fork 792
Return Module Update #11538
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.
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
Open
MarkTr0
wants to merge
6
commits into
mendix:development
Choose a base branch
from
MarkTr0:solp/4063-revert-documentation
base: development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+52
−0
Open
Return Module Update #11538
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ad2c9a6
Remove module updates part
mikita-haurykau 5e79d54
Revert "Remove module updates part"
MarkTr0 4895992
Fixed links in module settings
MarkTr0 50b5547
Review
quinntracy dd7715b
Move line
quinntracy a1f4fc8
Unreleased feature
MarkTr0 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
.../en/docs/refguide/modeling/app-explorer/modules/updating-marketplace-modules.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| title: "Updating Marketplace Modules" | ||
| url: /refguide/updating-marketplace-modules/ | ||
| weight: 40 | ||
| description: "How to update Marketplace modules in Studio Pro while retaining your customizations using three-way merge." | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| {{% alert color="info" %}} | ||
| This feature requires Studio Pro 11.12 or above. | ||
| {{% /alert %}} | ||
|
|
||
| Previously, when you wanted to update a Marketplace module to a newer version, you had to fully replace it, losing any customizations such as modified microflows or added functionality. | ||
|
|
||
| Studio Pro 11.12 changes this by enabling module updates that retain your customizations. When you update a module, Studio Pro performs a three-way merge that combines your customizations with the publisher's updates. You can keep your changes and benefit from bug fixes and new features in the updated module. | ||
|
|
||
| ## How Module Updates Work | ||
|
|
||
| ### Three-Way Merge Process | ||
|
|
||
| To retain your customizations when updating a module, Studio Pro performs a three-way merge using three versions: | ||
|
|
||
| 1. Original version – The version of the Marketplace module that you originally imported. | ||
| 2. Current version – The version currently in your app, which may include your modifications. | ||
| 3. Target version – The new version of the Marketplace module that you want to upgrade to. | ||
|
|
||
| You must manually provide both the original and target versions. If document mapping succeeds, the merge begins. If mapping fails, you cannot upgrade while keeping your customizations and must fully replace the module instead. | ||
|
|
||
| During the merge, conflicts may occur if you and the publisher both modified the same element (for example, the same microflow). For information on resolving conflicts, see [Combining Changes and Resolving Conflicts](/refguide/resolving-conflicts/). | ||
|
|
||
| ### Document Mapping | ||
|
|
||
| To merge your customizations with the updated module, Studio Pro matches documents between the old and new versions. The method depends on whether the module has package IDs: | ||
|
|
||
| * Modules with package IDs – Studio Pro uses embedded GUID mapping to match documents by GUID. This is more reliable because documents can be matched even if they have been renamed. | ||
|
|
||
| {{% alert color="info" %}} | ||
| Studio Pro 11.12 introduced package IDs and document GUID mappings to make updates more reliable. | ||
| {{% /alert %}} | ||
|
|
||
| For more information on package IDs and how they are assigned, see [Module Settings](/refguide/module-settings/#package). | ||
|
|
||
| ## Read More | ||
|
|
||
| * [Modules](/refguide/modules/) | ||
| * [Module Settings](/refguide/module-settings/) | ||
| * [Consuming Add-on Modules and Solutions](/refguide/consume-add-on-modules-and-solutions/) | ||
| * [Combining Changes and Resolving Conflicts](/refguide/resolving-conflicts/) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After the 11.13 freeze we should check whether 'name mapping' made it into this release, and if not, update the PR contents.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tom is right, name matching is not making it, so it is removed from docs