PR for SRVLOGIC-976: Add a section about explaining the workflow id naming and versioning recommended practices and limitations in the OSL product docs#112874
Conversation
…w identifiers and versioning
openshift-ci-robot
added
the
jira/valid-reference
|
@kaldesai: This pull request references SRVLOGIC-976 which is a valid jira issue. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
Bot
added
the
size/L
|
🤖 Mon Jun 08 08:33:25 - Prow CI generated the docs preview: |
|
/test validate-asciidoc |
|
/retest |
1 similar comment
|
/retest |
|
@kaldesai: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
/ serverless |
| |Represents the workflow `id` from YAML | ||
|
|
||
| |`sonataflow.org/name` | ||
| |Optional human-readable name annotation |
There was a problem hiding this comment.
I think that here we can also clarify that this value must match the configured value in the YAML if it was configured. Since we would like "name" field in the YAML and the SonataFlow name annotation be the same value.
| |Optional human-readable name annotation | ||
|
|
||
| |`sonataflow.org/description` | ||
| |Optional description annotation |
There was a problem hiding this comment.
For the description same concept as for the name.
| |Optional description annotation | ||
|
|
||
| |`sonataflow.org/version` | ||
| |Must match version from workflow YAML |
There was a problem hiding this comment.
good clarification here, it must match the value from the yaml.
|
|
||
| This approach ensures clarity and avoids conflicts when managing multiple workflow iterations. | ||
|
|
||
| The following example displays Version 1.0 workflow: |
There was a problem hiding this comment.
Thanks for adding these examples showing to move from version 1.0 to 2.0.
Do you think we can the corresponding:
apiVersion: sonataflow.org/v1alpha08
kind: SonataFlow
metadata:
name: hello-world
too?
Not sure if it could derive in something too long 🤔 , but could be helpful.
4 participants
You can cherry-pick for the following branches:
serverless-docs-1.38serverless-docs-1.37Tracking JIRA: https://redhat.atlassian.net/browse/SRVLOGIC-976
Changes:
Added a "Managing Workflow identifiers and versioning" section under the Getting started directory.
Reviews: