search

camunda / bpmnlint-plugin-camunda-compat

A bpmnlint plug-in for Camunda BPMN compatibility.
MIT License
0 stars 2 forks source link

`secrets` Rule Should Report Warning Instead of Error #132

Closed Oleksiivanov closed 12 months ago

Oleksiivanov commented 1 year ago

secrets.FOO produces a lint error stating that the secret expression is not valid. In fact, this format is currently supported but will be deprecated in the future. Therefore the lint error should be a warning instead. The message should indicate the future deprecation and the new format ({{secrets.FOO}}).

Follow-up to https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/119

bastiankoerber commented 1 year ago

can we change it to warning, since we get a lot of support requests. We are still supporting the old format, but we want to deprecate it, that's why we should throw a warning and not an error

philippfromme commented 1 year ago

The information about a currently supported pattern we want to deprecate was missing in the original issue. This is vital information. The error message should then be adjusted as well (e.g. The secret format you're using will be deprecated in future versions of Camunda 8. Use {{secrets.FOO}} instead.).

Oleksiivanov commented 1 year ago

Added to description current support secrets format , as was also described here : https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/116 I agree with format of message : The secret format you're using will be deprecated in future versions of Camunda 8. Use {{secrets.FOO}} instead.. @bastiankoerber , it is ok for you?

bastiankoerber commented 1 year ago

looks good, are we adding a hint in our documentation as well?

Oleksiivanov commented 1 year ago

looks good, are we adding a hint in our documentation as well?

Yes , PR with docs - https://github.com/camunda/camunda-platform-docs/pull/2554

philippfromme commented 1 year ago

as was also described here

I cannot find that information in the original pull request. I was assuming that we introduced secrets altogether. We can ship a patch release adjusting the error to be a warning with the adjusted message.

Oleksiivanov commented 1 year ago

as was also described here

I cannot find that information in the original pull request. I was assuming that we introduced secrets altogether. We can ship a patch release adjusting the error to be a warning with the adjusted message.

it will be cool to add this as a patch release, Thank you.

philippfromme commented 12 months ago

Since we can't show warnings in the properties panel right now, I will disable the rule until we're ready to report warnings instead of errors.

philippfromme commented 12 months ago

Closed by https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/133. We'll enable the rule once we've fixed the issues.