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

Add execution platform compatibility section for element templates #4780

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

jarekdanielak
Copy link
Contributor

Description

Related to https://github.com/camunda/product-hub/issues/2368

With Element Templates Runtime Versions feature integrated in both Desktop and Web Modelers, we should add it to the documentation.

Element template JSON schema has a new engines property which can be used to specify template's compatibility with different execution platforms.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@jarekdanielak jarekdanielak added kind/feature Issues related with features to be documented component:modeler Issues related with Modeler project 8.7.0-alpha2 December 2024 alpha release labels Dec 16, 2024
@jarekdanielak jarekdanielak requested review from barmac and a team December 16, 2024 17:30
@jarekdanielak jarekdanielak self-assigned this Dec 16, 2024
Copy link
Contributor

github-actions bot commented Dec 16, 2024

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still in draft because you have additional changes you would like to make? I see this is flagged for alpha-2, which went out last week. Do you require urgent review and release?

@jarekdanielak jarekdanielak added 8.7.0-alpha3 January 2024 alpha release and removed 8.7.0-alpha2 December 2024 alpha release labels Dec 17, 2024
@jarekdanielak
Copy link
Contributor Author

Fixed the target release label, sorry about that!

@jarekdanielak
Copy link
Contributor Author

Thanks @barmac, suggestions applied.

Backported to 8.6 and 8.5.

barmac
barmac previously approved these changes Dec 17, 2024
Copy link
Contributor

@barmac barmac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment still to address, but it looks good to me. @christinaausley would you say this makes sense to you? I might be biased as I was close to the implementation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.7.0-alpha3 January 2024 alpha release component:modeler Issues related with Modeler project kind/feature Issues related with features to be documented
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

3 participants