You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASE_NOTES.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## What's Changed
2
2
3
-
We've done a lot of work over the last 8 months to the SpiffWorkflow library as we've developed [SpiffArena](https://www.spiffworkflow.org/), a general purpose workflow managment system built ontop of this library.
3
+
We've done a lot of work over the last 8 months to the SpiffWorkflow library as we've developed [SpiffArena](https://www.spiffworkflow.org/), a general purpose workflow management system built on top of this library.
4
4
This has resulted in just a handful of new features. Our main focus was on making SpiffWorkflow more predictable, easier to use, and internally consistent.
5
5
6
6
## Breaking Changes from 1.x:
@@ -9,10 +9,10 @@ This has resulted in just a handful of new features. Our main focus was on makin
9
9
## Features and Improvements
10
10
11
11
### Task States, Transitions, Hooks, and Execution
12
-
Previous to 2.0, SpiffWorklow was a little weird about it's states, performing the actual execution in the on_complete() hook.
12
+
Previous to 2.0, SpiffWorklow was a little weird about its states, performing the actual execution in the on_complete() hook.
13
13
This was VERY confusing.
14
14
Tasks now have a _run() command separate from state change hooks.
15
-
The return value of the _run() command can be true (worked), false (failure) or None (not yet done).
15
+
The return value of the _run() command can be true (worked), false (failure), or None (not yet done).
16
16
This opens the door for better overall state management at the moment it is most critical (when the task is actually executing).
17
17
We also added new task state called "STARTED" that describes when a task was started, but hasn't finished yet, an oddly missing state in previous versions.
18
18
@@ -31,22 +31,22 @@ Timer events are now parsed according to the [ISO 8601 standard](https://en.wiki
31
31
* reset boundary events in loops by @essweine in https://github.com/sartography/SpiffWorkflow/pull/294
32
32
* Bugfix/execute event gateways on ready by @essweine in https://github.com/sartography/SpiffWorkflow/pull/308
33
33
34
-
### Improved Muliti-Instance Tasks
34
+
### Improved Multi-Instance Tasks
35
35
We refactored how Multi-instance tasks are handled internally, vastly simplifying their representation during execution and serialization.
36
-
No more 'phantom gateways'.
36
+
No more 'phantom gateways.'
37
37
* Feature/multiinstance refactor by @essweine in https://github.com/sartography/SpiffWorkflow/pull/292
38
38
39
-
### Improved Sub-Processes
40
-
SpiffWorkflow did not previously distinguish between a Call Activity and a SubProcess however they handle Data Objects very differently.
41
-
A Sub Process is now able to access it's parent data objects, a Call Activity can not.
39
+
### Improved SubProcesses
40
+
SpiffWorkflow did not previously distinguish between a Call Activity and a SubProcess, but they handle Data Objects very differently.
41
+
A SubProcess is now able to access its parent data objects, a Call Activity can not.
42
42
We also wanted the ability to execute Call Activities independently of the parent process.
43
43
44
44
* Bugfix/subprocess access to data objects by @essweine in https://github.com/sartography/SpiffWorkflow/pull/296
45
45
* start workflow while subprocess is waiting by @essweine in https://github.com/sartography/SpiffWorkflow/pull/302
46
46
* use same data objects & references in subprocesses after deserialization by @essweine in https://github.com/sartography/SpiffWorkflow/pull/314
47
47
48
48
### Improved Data Objects / Data Stores
49
-
This work will continue in subsequent releases, but we have added support for Data Stores, and it is possible provide your own implementations.
49
+
This work will continue in subsequent releases, but we have added support for Data Stores, and it is possible to provide your own implementations.
50
50
* Data stores by @jbirddog in https://github.com/sartography/SpiffWorkflow/pull/298
51
51
* make data objects available to gateways by @essweine in https://github.com/sartography/SpiffWorkflow/pull/325
52
52
@@ -62,9 +62,9 @@ We previously supported adding a pre-script or post-script to any task but there
62
62
63
63
### DMN Improvements
64
64
We now support a new hit policy of "COLLECT" which allows you to match on an array of items. DMN support is still limited, but
65
-
we are making headway. Would love to know if people are using these features.
65
+
we are making headway. We would love to know if people are using these features.
66
66
* Support for the "COLLECT" hit policy. by @danfunk in https://github.com/sartography/SpiffWorkflow/pull/267
67
-
* Bugfix/handle dash in dmn by @essweine in https://github.com/sartography/SpiffWorkflow/pull/323
67
+
* Bugfix/handle dash in DMN by @essweine in https://github.com/sartography/SpiffWorkflow/pull/323
68
68
69
69
### BPMN Validation
70
70
We improved validation of BPMN and DMN Files to catch errors earlier.
@@ -76,7 +76,7 @@ your serialized workflows to the new format, but you will definitely encounter i
76
76
* update serializer version by @essweine in https://github.com/sartography/SpiffWorkflow/pull/277
77
77
* Feature/remove old serializer by @essweine in https://github.com/sartography/SpiffWorkflow/pull/278
78
78
79
-
### Lightening Fast, Stable Tests
79
+
### Lightning Fast, Stable Tests
80
80
* Fix ResourceWarning: unclosed file BpmnParser.py:60 by @jbirddog in https://github.com/sartography/SpiffWorkflow/pull/270
81
81
* Option to run tests in parallel by @jbirddog in https://github.com/sartography/SpiffWorkflow/pull/271
82
82
@@ -95,18 +95,18 @@ Make it easier to reference SpiffWorkflow library classes from your own code.
95
95
* cleaning up code smell by @danfunk in https://github.com/sartography/SpiffWorkflow/pull/261
96
96
* Feature/cleanup task completion by @essweine in https://github.com/sartography/SpiffWorkflow/pull/263
97
97
* disambiguate DMN expressions by @essweine in https://github.com/sartography/SpiffWorkflow/pull/264
98
-
* Add in memory bpmn/dmn parser functions by @jbirddog in https://github.com/sartography/SpiffWorkflow/pull/320
98
+
* Add in memory BPMN/DMN parser functions by @jbirddog in https://github.com/sartography/SpiffWorkflow/pull/320
99
99
100
100
### Better Introspection
101
-
Added the abilty to ask SpiffWorkflow some useful questions about a specification such as "What call activities does this depend on?",
101
+
Added the ability to ask SpiffWorkflow some useful questions about a specification such as, "What call activities does this depend on?",
102
102
"What messages does this process send and receive", and "What lanes exist on this workflow specification?"
103
103
* Parser Information about messages, correlation keys, and the presence of lanes by @danfunk in https://github.com/sartography/SpiffWorkflow/pull/262
104
104
* Called elements by @jbirddog in https://github.com/sartography/SpiffWorkflow/pull/316
105
105
106
106
### Code Cleanup
107
107
* Improvement/task spec attributes by @essweine in https://github.com/sartography/SpiffWorkflow/pull/328
108
108
* update license by @essweine in https://github.com/sartography/SpiffWorkflow/pull/324
109
-
* Feature/remove unused bpmn attributes and methods by @essweine in https://github.com/sartography/SpiffWorkflow/pull/280
109
+
* Feature/remove unused BPMN attributes and methods by @essweine in https://github.com/sartography/SpiffWorkflow/pull/280
110
110
* Improvement/remove camunda from base and misc cleanup by @essweine in https://github.com/sartography/SpiffWorkflow/pull/295
111
111
* remove minidom by @essweine in https://github.com/sartography/SpiffWorkflow/pull/300
112
112
* Feature/remove loop reset by @essweine in https://github.com/sartography/SpiffWorkflow/pull/305
@@ -118,7 +118,7 @@ Added the abilty to ask SpiffWorkflow some useful questions about a specificatio
118
118
### Improved Documentation
119
119
* Fixes grammar, typos, and spellings by @rachfop in https://github.com/sartography/SpiffWorkflow/pull/291
120
120
* Updates for 2.0 release by @essweine in https://github.com/sartography/SpiffWorkflow/pull/330
121
-
* Bugfix/non bpmn tutorial by @essweine in https://github.com/sartography/SpiffWorkflow/pull/317
121
+
* Bugfix/non BPMN tutorial by @essweine in https://github.com/sartography/SpiffWorkflow/pull/317
122
122
123
123
### Bug Fixes
124
124
* correct xpath for extensions by @essweine in https://github.com/sartography/SpiffWorkflow/pull/265
0 commit comments