-
Notifications
You must be signed in to change notification settings - Fork 784
Refguide Package management foundation #11307
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
mikita-haurykau
wants to merge
1
commit into
mendix:development
Choose a base branch
from
mikita-haurykau:solp-3865-release-feature-branch
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.
+115
−2
Open
Changes from all commits
Commits
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
46 changes: 46 additions & 0 deletions
46
.../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,46 @@ | ||
| --- | ||
| title: "Updating Marketplace Modules" | ||
| url: /refguide/updating-marketplace-modules/ | ||
| weight: 40 | ||
| description: "Describes how to update Marketplace modules while retaining your customizations using three-way merge." | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| Previously, when you wanted to update a Marketplace module to a newer version, you had to fully replace the module. This meant losing any customizations you had made, such as modified microflows or added functionality. If you had customized a module, you had to choose between keeping your changes or getting the latest updates from the publisher. | ||
|
|
||
| Studio Pro 11.12 changes this by enabling module updates that retain your customizations. Now, when you update a module, Studio Pro performs a three-way merge that intelligently combines your customizations with the publisher's updates. This means you can both keep your changes and benefit from bug fixes and new features in the updated module. | ||
|
|
||
| {{% alert color="info" %}} | ||
| Studio Pro 11.12 introduces improved package management with package IDs and document GUID mappings that make updates more reliable. However, updates with customization retention also work for older modules without package IDs through name-based mapping. For more information on package management, see [Module Settings](/refguide/module-settings/#package). | ||
| {{% /alert %}} | ||
|
|
||
| ## Updating Modules with Three-Way Merge | ||
|
|
||
| ### Three-Way Merge Process | ||
|
|
||
| To retain your customizations when updating a module, Studio Pro performs a three-way merge. This process requires 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 the mapping of documents succeeds, the merge begins. If mapping fails, you cannot upgrade while keeping your customizations, and you must fully overwrite the module. | ||
|
|
||
| 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 successfully merge your customizations with the updated module, Studio Pro needs to match documents between the old and new versions. The method Studio Pro uses depends on whether the module has package identification: | ||
|
|
||
| * **Modules with package IDs** – Studio Pro uses the embedded GUID mapping information to match documents by GUID. This is more reliable because documents can be matched even if they have been renamed. | ||
| * **Modules without package IDs** – Studio Pro attempts to map documents by name. This works well as long as document names have not changed between versions. | ||
|
|
||
| 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.
Let's add a warning here that the Marketplace will not allow you to publish a module with an ID that is already owned by another publisher.