Skip to content
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

New function: Help developer in upgrading marketplace modules by showing what has changed #4

Open
xiwenc opened this issue Apr 10, 2024 · 3 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@xiwenc
Copy link
Contributor

xiwenc commented Apr 10, 2024

Use case

Developers tend to change modules imported from Marketplace. However these changes are often not tracked well which makes it tricky/risky to upgrade the module in the future

Solution

Within a project, show the developer what changes were made in comparison to original version of a module. These can also be not marketplace modules; so any module.

@xiwenc xiwenc added the enhancement New feature or request label Apr 10, 2024
@xiwenc
Copy link
Contributor Author

xiwenc commented Apr 10, 2024

Input collected from Linkedin:

Paul P:

I haven't familiarized myself with the data structure yet, but is it possible to detect which Marketplace modules are in the app and their versions? Best of all, when there is no 100% match do a guestimate which version it likely is and which customizations were made? That would be a killer feature for migration impact analysis.

Xiwen:

partly yes. See https://github.com/cinaq/mendix-cli/blob/main/modelsource/Metadata.yaml so version is already present. Indeed detection whether there were modifications are not yet possible. It would be if we have exports of all known market place modules and their versions. That way we can use these to compare; which is a breeze now because they are all yaml files. Or perhaps we can do fingerprinting for efficiency. But having the whole module to compare we can even show what has changed compared to the original module.

Xiwen:

this would be a new “mendix-cli compare-module” function. Great idea! Now… who is up for the task to implement this?

Paul P:

Exactly what I had in mind. Building a library with modules and their versions is a matter of time. And if there is a simple way for the community to add their scan results then it is a distributed effort.

@xiwenc xiwenc added the help wanted Extra attention is needed label Apr 10, 2024
@gplo
Copy link

gplo commented Apr 11, 2024

Probably no new info here, but you can use the Mendix marketplace-api to do this. For example: https://marketplace-api.mendix.com/v1/content/{package_id}/versions. It returns a JSON which includes the version, release date and release notes.

@xiwenc
Copy link
Contributor Author

xiwenc commented Apr 11, 2024

Thanks for sharing this! I didn't know this existed. I wonder if we can also download packages automatically?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants