Skip to content

Commit b1c0018

Browse files
author
Tihomir Surdilovic
authored
Updated spec doc status message and restructured roadmap doc (#236)
Signed-off-by: Tihomir Surdilovic <[email protected]>
1 parent 11bf192 commit b1c0018

File tree

2 files changed

+56
-49
lines changed

2 files changed

+56
-49
lines changed

‎roadmap/README.md

Lines changed: 50 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Serverless Workflow Roadmap
1+
# Specification Roadmap
22

33
_Note: Items in tables for each milestone do not imply an order of implementation._
44

@@ -12,35 +12,35 @@ _Status description:_
1212

1313
## Releases
1414

15-
- [v0.1 released April 2020](#v01)
15+
- [Roadmap for next planned release](#v06)
1616
- [v0.5 released November 2020](#v05)
17-
- [v0.6 release date TBD](#v06)
17+
- [v0.1 released April 2020](#v01)
1818

19-
## <a name="v01"></a> v0.1
19+
## <a name="v06"></a> Next planned release
2020

2121
| Status | Description | Comments |
22-
| :--: | --- | --- |
23-
| ✔ | Establish governance, contributing guidelines and initial stakeholder | [governance doc](https://github.com/cncf/wg-serverless/tree/v0.1/workflow/spec/governance) |
24-
| ✔ | Define specification goals | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
25-
| ✔ | Define specification functional scope | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
26-
| ✔ | Include set of use-cases for Serverless Workflow | [usecases doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/usecases.md) |
27-
| ✔ | Include set of examples for Serverless Workflow | [examples doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/examples.md) |
28-
| ✔ | Define specification JSON Schema | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
29-
| ✔ | Add SubFlow state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
30-
| ✔ | Add Relay state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
31-
| ✔ | Add ForEach state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
32-
| ✔ | Update Event state| [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
33-
| ✔ | Define Workflow data input/output | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
34-
| ✔ | Update state data filtering | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
35-
| ✔ | Clearly define workflow info passing | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
36-
| ✔ | Add Workflow error handling | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
37-
| ✔ | Add reusable function definitions | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
38-
| ✔ | Add support for YAML definitions | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
39-
| ✔ | Update workflow end definition | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
40-
| ✔ | Add Callback state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
41-
| ✔ | Add workflow metadata | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
42-
| ✔️| Update workflow start definition | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
43-
| ✔️| Prepare github branch and docs for v0.1 | [branch](https://github.com/cncf/wg-serverless/tree/v0.1/workflow/spec) |
22+
| --- | --- | --- |
23+
| ✔️| Adding Workflow Compensation capabilities (cmp [Compensating Transaction](https://docs.microsoft.com/en-us/azure/architecture/patterns/compensating-transaction), [SAGA pattern](https://microservices.io/patterns/data/saga.html)) | [spec doc](../specification.md) |
24+
| ✔️| Adding comparison examples with Google Cloud Workflow language| [examples doc](../examples/examples-google-cloud-workflows.md) |
25+
| ✔️| Updates to retry functionality | [retries: exponential backoff & max backoff](https://github.com/serverlessworkflow/specification/issues/137) [retries: max-attempts & interval](https://github.com/serverlessworkflow/specification/issues/136)|
26+
| ✔️| Update "directInvoke" property type | [spec doc](../specification.md) |
27+
| ✔️| Data schema input/output update | [spec doc](../specification.md) |
28+
| ✔️| Updating start and end state definitions| [spec doc](../specification.md) |
29+
| ✔️| Update cron definition (adding validUntil parameter)| [spec doc](../specification.md) |
30+
| ✔️| Adding comparison examples with Temporal | [examples doc](../examples/examples.md) |
31+
| ✔️| Simplified functionRef and transition properties | [spec doc](../specification.md) |
32+
| 🚩 | JSONPatch transformations | [issue](https://github.com/serverlessworkflow/specification/issues/149) |
33+
| 🚩 | JSONPatch transformations | [issue](https://github.com/serverlessworkflow/specification/issues/149) |
34+
| 🚩 | Workflow invocation bindings | |
35+
| 🚩 | CE Subscriptions & Discovery | |
36+
| 🚩 | Error types | [issue](https://github.com/serverlessworkflow/specification/issues/200) |
37+
| 🚩 | Uniqueness constraint for workflows | [issue](https://github.com/serverlessworkflow/specification/issues/146) |
38+
| 🚩 | Function invocations (GRPC) | |
39+
| 🚩 | OpenAPI endpoint selection | |
40+
| 🚩 | Data triggers | |
41+
| 🚩 | JSON schema checks | |
42+
| 🚩 | Start discussions on Serverless Workflow Technology Compatibility Kit (TCK) | |
43+
| ✏️ | Specification primer | [google doc](https://docs.google.com/document/d/11rD3Azj63G2Si0VpokSpr-1ib3mFRFHSwN6tJb-0LQM/edit#heading=h.paewfy83tetm) continued in [wiki](https://github.com/serverlessworkflow/specification/wiki) |
4444

4545
## <a name="v05"></a> v0.5
4646

@@ -75,27 +75,29 @@ _Status description:_
7575
| ✔️| Enforce use of OpenAPI specification in function definitions for portability | [spec doc](https://github.com/serverlessworkflow/specification/blob/0.5.x/specification.md) |
7676
| ✔️| Update workflow Error Handling | [spec doc](../specification.md) |
7777

78-
## <a name="v06"></a> v0.6
78+
79+
## <a name="v01"></a> v0.1
7980

8081
| Status | Description | Comments |
81-
| --- | --- | --- |
82-
| ✔️| Adding Workflow Compensation capabilities (cmp [Compensating Transaction](https://docs.microsoft.com/en-us/azure/architecture/patterns/compensating-transaction), [SAGA pattern](https://microservices.io/patterns/data/saga.html)) | [spec doc](../specification.md) |
83-
| ✔️| Adding comparison examples with Google Cloud Workflow language| [examples doc](../examples/examples-google-cloud-workflows.md) |
84-
| ✔️| Updates to retry functionality | [retries: exponential backoff & max backoff](https://github.com/serverlessworkflow/specification/issues/137) [retries: max-attempts & interval](https://github.com/serverlessworkflow/specification/issues/136)|
85-
| ✔️| Update "directInvoke" property type | [spec doc](../specification.md) |
86-
| ✔️| Data schema input/output update | [spec doc](../specification.md) |
87-
| ✔️| Updating start and end state definitions| [spec doc](../specification.md) |
88-
| ✔️| Update cron definition (adding validUntil parameter)| [spec doc](../specification.md) |
89-
| ✔️| Adding comparison examples with Temporal | [examples doc](../examples/examples.md) |
90-
| ✔️| Simplified functionRef and transition properties | [spc doc](../specification.md) |
91-
| 🚩 | JSONPatch transformations | [issue](https://github.com/serverlessworkflow/specification/issues/149) |
92-
| 🚩 | Workflow invocation bindings | |
93-
| 🚩 | CE Subscriptions & Discovery | |
94-
| 🚩 | Error types | [issue](https://github.com/serverlessworkflow/specification/issues/200) |
95-
| 🚩 | Uniqueness constraint for workflows | [issue](https://github.com/serverlessworkflow/specification/issues/146) |
96-
| 🚩 | Function invocations (GRPC) | |
97-
| 🚩 | OpenAPI endpoint selection | |
98-
| 🚩 | Data triggers | |
99-
| 🚩 | JSON schema checks | |
100-
| 🚩 | Start discussions on Serverless Workflow Technology Compatibility Kit (TCK) | |
101-
| ✏️ | Specification primer | [google doc](https://docs.google.com/document/d/11rD3Azj63G2Si0VpokSpr-1ib3mFRFHSwN6tJb-0LQM/edit#heading=h.paewfy83tetm) continued in [wiki](https://github.com/serverlessworkflow/specification/wiki) |
82+
| :--: | --- | --- |
83+
| ✔ | Establish governance, contributing guidelines and initial stakeholder | [governance doc](https://github.com/cncf/wg-serverless/tree/v0.1/workflow/spec/governance) |
84+
| ✔ | Define specification goals | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
85+
| ✔ | Define specification functional scope | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
86+
| ✔ | Include set of use-cases for Serverless Workflow | [usecases doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/usecases.md) |
87+
| ✔ | Include set of examples for Serverless Workflow | [examples doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/examples.md) |
88+
| ✔ | Define specification JSON Schema | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
89+
| ✔ | Add SubFlow state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
90+
| ✔ | Add Relay state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
91+
| ✔ | Add ForEach state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
92+
| ✔ | Update Event state| [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
93+
| ✔ | Define Workflow data input/output | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
94+
| ✔ | Update state data filtering | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
95+
| ✔ | Clearly define workflow info passing | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
96+
| ✔ | Add Workflow error handling | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
97+
| ✔ | Add reusable function definitions | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
98+
| ✔ | Add support for YAML definitions | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
99+
| ✔ | Update workflow end definition | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
100+
| ✔ | Add Callback state | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
101+
| ✔ | Add workflow metadata | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
102+
| ✔️| Update workflow start definition | [spec doc](https://github.com/cncf/wg-serverless/blob/v0.1/workflow/spec/spec.md) |
103+
| ✔️| Prepare github branch and docs for v0.1 | [branch](https://github.com/cncf/wg-serverless/tree/v0.1/workflow/spec) |

‎specification.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ targeting the serverless computing technology domain.
77

88
## Status of this document
99

10-
This document is a working draft.
10+
This document represents the current state of the specification.
11+
It includes all features so far released
12+
as well as all features planned to be added in the next release.
13+
14+
You can find all specification releases [here](https://github.com/serverlessworkflow/specification/releases).
15+
You can find the specification roadmap [here](roadmap/README.md).
1116

1217
## Table of Contents
1318

0 commit comments

Comments
 (0)