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

[WiP] Document Workflow 4.3 changes #11211

Open
wants to merge 4 commits into
base: master
from

Conversation

Projects
None yet
7 participants
@pbowyer
Copy link
Contributor

pbowyer commented Mar 23, 2019

Document the changes in https://github.com/symfony/workflow/blob/master/CHANGELOG.md and https://github.com/symfony/symfony/blob/master/UPGRADE-4.3.md#workflow:

WiP, more to be added. Community input/commits very welcome!

@@ -80,7 +81,8 @@ like this:
<framework:workflow name="blog_publishing" type="workflow">
<framework:audit-trail enabled="true"/>
<framework:marking-store type="single_state">
<framework:marking-store type="method">
<framework:argument>false</framework:argument>
<framework:argument>currentPlace</framework:argument>
</framework:marking-store>

This comment has been minimized.

Copy link
@pbowyer

pbowyer Mar 23, 2019

Author Contributor

I don't use XML config, can someone please provide the initial_places code for it.

This comment has been minimized.

This comment has been minimized.

Copy link
@lyrixx

lyrixx Apr 7, 2019

Member

It would be nice to add it in the code doc.
Here is the final ref

This comment has been minimized.

Copy link
@pbowyer

pbowyer Apr 7, 2019

Author Contributor

I believe I've done this correctly!

@noniagriconomie

This comment has been minimized.

Copy link
Contributor

noniagriconomie commented Mar 28, 2019

Hi
Just wanted to notify you this PR #10751 (to be merged soon i think)

@lyrixx
Copy link
Member

lyrixx left a comment

Thanks a lot for this PR.


This is an extract of the upcomming blog post:
I hope it will help you to update this PR.


A subject in a state machine can be in only one state whereas a subject in a
workflow can be in one or more places. From the first day of the Workflow
Component we let the user to be able to use a Workflow with a Single State
Marking Store. This was a mistake and this added some useless complexity.

As of now, If your subject can be in only on state: use a state machine. In that
case, the property (marking by default) will be a string. If the subject can
be in many places: use a workflow. In that case, the property will be an array.

Show resolved Hide resolved workflow/usage.rst Outdated
Show resolved Hide resolved workflow/usage.rst Outdated
Show resolved Hide resolved workflow/usage.rst Outdated
@@ -80,7 +81,8 @@ like this:
<framework:workflow name="blog_publishing" type="workflow">
<framework:audit-trail enabled="true"/>
<framework:marking-store type="single_state">
<framework:marking-store type="method">
<framework:argument>false</framework:argument>
<framework:argument>currentPlace</framework:argument>
</framework:marking-store>

This comment has been minimized.

Copy link
@lyrixx

lyrixx Apr 7, 2019

Member

It would be nice to add it in the code doc.
Here is the final ref

Show resolved Hide resolved workflow/usage.rst
@pbowyer

This comment has been minimized.

Copy link
Contributor Author

pbowyer commented Apr 7, 2019

Thanks for the review @lyrixx! I'll wait for #10751 to merge, rebase and then incorporate your feedback 👍

@xabbuh

This comment has been minimized.

Copy link
Member

xabbuh commented Apr 7, 2019

@pbowyer #10751 is merged, sorry for the delay.

pbowyer added some commits Mar 23, 2019

Update `initial_place` to `initial_places`.
Add missing `initial_places` to PHP configuration example. Someone needs to add it to the XML

@pbowyer pbowyer force-pushed the pbowyer:feature/workflow-4.3 branch from d8a19c3 to 6c636cb Apr 7, 2019

@javiereguiluz

This comment has been minimized.

Copy link
Member

javiereguiluz commented Apr 17, 2019

@pbowyer I regret to inform you that we've just merged a full reorganization of Workflow docs. This will introduce conflicts with your PR. I was postponing the merge, but it was only making things worse. If you don't want to rebase and fix the conflicts, I can create a new PR for you with your changes. I'm sorry.

The main changes are:

  • /workflow.rst now contains the full usage example (everything tht previously was in /workflow/usage.rst
  • The old /workflow.rst contents and the /workflow/state-machines.rst contents have been moved to a new introduction article: /workflow/introduction.rst
  • /workflow/usage.rst and /workflow/state-machines.rst have been deleted.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.