Skip to content

Commit f0bf79b

Browse files
committed
copy edits
1 parent a7c7269 commit f0bf79b

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

RELEASE_NOTES.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## What's Changed
22

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.
44
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.
55

66
## 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
99
## Features and Improvements
1010

1111
### 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.
1313
This was VERY confusing.
1414
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).
1616
This opens the door for better overall state management at the moment it is most critical (when the task is actually executing).
1717
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.
1818

@@ -31,22 +31,22 @@ Timer events are now parsed according to the [ISO 8601 standard](https://en.wiki
3131
* reset boundary events in loops by @essweine in https://github.com/sartography/SpiffWorkflow/pull/294
3232
* Bugfix/execute event gateways on ready by @essweine in https://github.com/sartography/SpiffWorkflow/pull/308
3333

34-
### Improved Muliti-Instance Tasks
34+
### Improved Multi-Instance Tasks
3535
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.'
3737
* Feature/multiinstance refactor by @essweine in https://github.com/sartography/SpiffWorkflow/pull/292
3838

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.
4242
We also wanted the ability to execute Call Activities independently of the parent process.
4343

4444
* Bugfix/subprocess access to data objects by @essweine in https://github.com/sartography/SpiffWorkflow/pull/296
4545
* start workflow while subprocess is waiting by @essweine in https://github.com/sartography/SpiffWorkflow/pull/302
4646
* use same data objects & references in subprocesses after deserialization by @essweine in https://github.com/sartography/SpiffWorkflow/pull/314
4747

4848
### 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.
5050
* Data stores by @jbirddog in https://github.com/sartography/SpiffWorkflow/pull/298
5151
* make data objects available to gateways by @essweine in https://github.com/sartography/SpiffWorkflow/pull/325
5252

@@ -62,9 +62,9 @@ We previously supported adding a pre-script or post-script to any task but there
6262

6363
### DMN Improvements
6464
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.
6666
* 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
6868

6969
### BPMN Validation
7070
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
7676
* update serializer version by @essweine in https://github.com/sartography/SpiffWorkflow/pull/277
7777
* Feature/remove old serializer by @essweine in https://github.com/sartography/SpiffWorkflow/pull/278
7878

79-
### Lightening Fast, Stable Tests
79+
### Lightning Fast, Stable Tests
8080
* Fix ResourceWarning: unclosed file BpmnParser.py:60 by @jbirddog in https://github.com/sartography/SpiffWorkflow/pull/270
8181
* Option to run tests in parallel by @jbirddog in https://github.com/sartography/SpiffWorkflow/pull/271
8282

@@ -95,18 +95,18 @@ Make it easier to reference SpiffWorkflow library classes from your own code.
9595
* cleaning up code smell by @danfunk in https://github.com/sartography/SpiffWorkflow/pull/261
9696
* Feature/cleanup task completion by @essweine in https://github.com/sartography/SpiffWorkflow/pull/263
9797
* 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
9999

100100
### 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?",
102102
"What messages does this process send and receive", and "What lanes exist on this workflow specification?"
103103
* Parser Information about messages, correlation keys, and the presence of lanes by @danfunk in https://github.com/sartography/SpiffWorkflow/pull/262
104104
* Called elements by @jbirddog in https://github.com/sartography/SpiffWorkflow/pull/316
105105

106106
### Code Cleanup
107107
* Improvement/task spec attributes by @essweine in https://github.com/sartography/SpiffWorkflow/pull/328
108108
* 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
110110
* Improvement/remove camunda from base and misc cleanup by @essweine in https://github.com/sartography/SpiffWorkflow/pull/295
111111
* remove minidom by @essweine in https://github.com/sartography/SpiffWorkflow/pull/300
112112
* 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
118118
### Improved Documentation
119119
* Fixes grammar, typos, and spellings by @rachfop in https://github.com/sartography/SpiffWorkflow/pull/291
120120
* 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
122122

123123
### Bug Fixes
124124
* correct xpath for extensions by @essweine in https://github.com/sartography/SpiffWorkflow/pull/265

0 commit comments

Comments
 (0)