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

Upgrade path for deprecated element templates #72

Open
sbuettner opened this issue Feb 28, 2024 · 3 comments
Open

Upgrade path for deprecated element templates #72

sbuettner opened this issue Feb 28, 2024 · 3 comments
Labels
backlog Queued in backlog element templates enhancement New feature or request

Comments

@sbuettner
Copy link

sbuettner commented Feb 28, 2024

Is your feature request related to a problem? Please describe.

The deprecation feature that is currently available as part of the element-template schema only supports a documentation and text messages.

It would be helpful to allow to define am migrationElementTemplateId as part of the deprecation that can be used as an upgrade path. This would allow to migrate from a deprecated element-template to a another one.

Describe the solution you'd like

Supporting migration paths could be integrated into the deprecated object in addition to the already supported message:

...
  "deprecated": {
    "message": "This template is not supported anymore. Please migrate",
    "migrationElementTemplateId": "my-new-element-template-id"
  },
...

A "migrate" option is given to the user, and activating it will use the standard replace mechanism to upgrade.

Describe alternatives you've considered

An alternative would be to link to the new element template in the existing text fields but this require additional work and would for example not support an automatic migration to another element template without user interaction.

@sbuettner sbuettner added the enhancement New feature or request label Feb 28, 2024
@nikku
Copy link
Member

nikku commented Mar 7, 2024

This would offer additional user guidance for our migration journey, which is currently manual, i.e. not tool supported.

To better understand your use-case: Under the hood this would still be a normal "replace with other task", using our existing upgrade behavior?

@nikku nikku added the needs more information Requires additional information to be actionable. label Mar 7, 2024
@sbuettner
Copy link
Author

Yes, exactly.

@nikku nikku added backlog Queued in backlog and removed needs more information Requires additional information to be actionable. labels Mar 18, 2024
@nikku
Copy link
Member

nikku commented Mar 18, 2024

Thanks. Updated the issue accordingly. Moving to backlog for the time being. To be prioritized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Queued in backlog element templates enhancement New feature or request
Development

No branches or pull requests

2 participants