docs(play): add scenarios section #4737
Open
+50
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👋 🤖 🤔 Hello, @mesellings! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
|
@huygur Which alpha/minor is this for please? |
@mesellings sorry I forgot to add the label 🤦♀️ it's there now |
huygur
commented
Dec 10, 2024
| - Scenarios are stored in the browser's local storage, making them accessible only in the current browser and not usable outside of Play or in a different browser. | ||
| - Call activities are not supported; therefore, scenarios containing them cannot be executed successfully. | ||
| - Scenario paths that include process modifications are not supported. | ||
| - Similar to process instances, scenarios do not run in isolation. For instance, if two scenario paths are defined for a process and both contain the same message event or signal event, running these scenarios simultaneously may lead to unintended consequences. Publishing a scenario or broadcasting a signal could inadvertently impact the other scenario, resulting in the failure of both. |
There was a problem hiding this comment.
💭 It could be nice to include a link to the documentation for the nature of message events and signal events, where the issue with global publish/broadcast is mentioned. However, I am not aware of such a link at this moment.
HanselIdes
reviewed
Dec 12, 2024
|
|
||
| - Scenarios are stored in the browser's local storage, making them accessible only in the current browser and not usable outside of Play or in a different browser. | ||
| - Call activities are not supported; therefore, scenarios containing them cannot be executed successfully. | ||
| - Scenario paths that include process modifications are not supported. |
There was a problem hiding this comment.
variable changes are actually supported
scenarios cover everything rewind feature does
| @@ -92,6 +92,38 @@ Play's rewind operation currently does not support the following elements: | |||
| - Play rewinds to an element, not to an element instance. For example, if you wanted to rewind your process to a sequential multi-instance service task which ran five times, it will rewind your process to the first instance of that service task. | |||
| - Play rewinds processes by initiating a new instance and executing each element. However, if any element behaves differently from the previous execution, such as a Connector returning a different result, the rewind may fail. | |||
|
|
|||
| ## Scenarios | |||
|
|
|||
| You can validate your process by creating scenarios for different paths, ensuring that it continues to function as expected after any changes to your diagram. Scenarios let you replay and confirm that the process completes correctly with the pre-defined actions and variables. | |||
There was a problem hiding this comment.
Suggested change
| You can validate your process by creating scenarios for different paths, ensuring that it continues to function as expected after any changes to your diagram. Scenarios let you replay and confirm that the process completes correctly with the pre-defined actions and variables. | |
| Scenarios accelerate manual testing by providing a no-code way of quickly re-running processes while tracking your test coverage. | |
| You can validate your process by creating and rerunning scenarios for different paths, ensuring that it continues to function as expected after any changes to your diagram. Scenarios let you replay and confirm that the process completes correctly with the pre-defined actions and variables. Although scenarios are quick to develop and use for non-developers, our [best practices](https://docs.camunda.io/docs/next/components/best-practices/development/testing-process-definitions/) suggest using specialized test libraries in your CI/CD pipeline. |
There was a problem hiding this comment.
I applied your suggestion 👍
I am not sure though, if we should call this a 'test coverage'. But I have no better suggestion 😅
There was a problem hiding this comment.
Yeah, me neither. I'm framing the value around accelerating manual testing
huygur
commented
Dec 12, 2024
|
|
||
| - Scenarios are stored in the browser's local storage, making them accessible only in the current browser and not usable outside of Play or in a different browser. | ||
| - Call activities are not supported; therefore, scenarios containing them cannot be executed successfully. | ||
| - Scenario paths that include process modifications are not supported. |
There was a problem hiding this comment.
variable changes are actually supported
scenarios cover everything rewind feature does
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| Scenarios accelerate manual testing by providing a no-code way of quickly re-running processes while tracking your test coverage. | ||
|
|
||
| You can validate your process by creating and rerunning scenarios for different paths, ensuring that it continues to function as expected after any changes to your diagram. Scenarios let you replay and confirm that the process completes correctly with the pre-defined actions and variables. Although scenarios are quick to develop and use for non-developers, our [best practices](https://docs.camunda.io/docs/next/components/best-practices/development/testing-process-definitions/) suggest using specialized test libraries in your CI/CD pipeline. |
There was a problem hiding this comment.
[all.hrefProduction] Improper link format: 'best practices'. Please use relative URLs.
mesellings
added
kind/feature
mesellings
approved these changes
Dec 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
related to https://github.com/camunda/play/issues/744
When should this change go live?
holdlabel or convert to draft PR)PR Checklist
/versioned_docsdirectory./docsdirectory (aka/next/).