camunda-modeler icon indicating copy to clipboard operation
camunda-modeler copied to clipboard

Element Template Runtime Versions

Open jarekdanielak opened this issue 1 year ago • 2 comments

This is a tracking issue for Element Template Runtime Versions epic.

Description

We want to detect, communicate and help users solve incompatibilities between their platform version and element template version.

We want to warn the user about the incompatibility in a non-blocking way, allowing them to fix the problem or continue with the deployment.

To do:

  • [ ] https://github.com/camunda/element-templates-json-schema/issues/146
  • [ ] Detect and act upon incompatibilities:
    • [ ] User tries to apply template that requires higher platform version.
    • [ ] User tries to apply template that requires lower platform version.
    • [ ] User downgrades platform version, but an already applied template requires higher version.
    • [ ] User upgrades platform version, but an already applied template requires lower version.
    • [ ] There is no version of a template that supports current runtime version.
  • [ ] Ensure user is always offered the most relevant template version.

Note:

  • Make sure the solution covers applying a template through both properties panel and element context menu.
  • Supported platform versions JSON field should be optional.
  • Current template upgrade feature should not offer an upgrade to an incompatible version.

Additional documentation

jarekdanielak avatar Sep 18 '24 07:09 jarekdanielak

Detect and act upon incompatibilities:

I'd add "User is offered templates relevant to his context".

nikku avatar Sep 18 '24 10:09 nikku

Yana has done some work on missing templates that might be informative. I'll go through it and see if there's anything we need to be aware of.

lmbateman avatar Sep 20 '24 13:09 lmbateman

@jarekdanielak Let's ensure we keep this issue (our tracking issue) updated and relevant during the course of the implementation. :slightly_smiling_face:

nikku avatar Nov 26 '24 10:11 nikku

Updated after latest discussions.

jarekdanielak avatar Dec 06 '24 08:12 jarekdanielak

Decision tree of choosing the latest compatible version of element template along with some edge use-cases.

excali-el-templates

jarekdanielak avatar Dec 06 '24 22:12 jarekdanielak

Reopening as there are still some integration and documentation tasks to do.

jarekdanielak avatar Dec 16 '24 16:12 jarekdanielak

With the feature integrated in both modelers and documentation pending to be merged, I consider this closed now.

jarekdanielak avatar Dec 18 '24 11:12 jarekdanielak