From f7f6ca26518a1fb11966851b40d2b3290aa25ef2 Mon Sep 17 00:00:00 2001 From: Daniel Stahl Date: Mon, 13 Jun 2016 13:30:12 +0200 Subject: [PATCH 1/3] Added EiffelFlowContextDefinedEvent documentation. --- README.md | 2 +- .../EiffelFlowContextDefinedEvent.md | 34 +++++++++++++++++++ 2 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 eiffel-vocabulary/EiffelFlowContextDefinedEvent.md diff --git a/README.md b/README.md index 0ac6d37a..7bc9b9f3 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ __IMPORTANT NOTICE:__ The contents of this repository currectly reflect a __DRAF 1. [EiffelCompositionDefinedEvent](./eiffel-vocabulary/EiffelCompositionDefinedEvent.md) 1. EiffelSourceChangeCreatedEvent 1. [EiffelSourceChangeSubmittedEvent](./eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md) - 1. EiffelFlowContextDefinedEvent + 1. [EiffelFlowContextDefinedEvent](./eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) 1. EiffelTestCaseStartedEvent 1. EiffelTestCaseFinishedEvent 1. EiffelTestSuiteStartedEvent diff --git a/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md b/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md new file mode 100644 index 00000000..052ea234 --- /dev/null +++ b/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md @@ -0,0 +1,34 @@ +# EiffelFlowContextDefined +The EiffelFlowContextDefined describes the context of other events, answering questions such as "Which project is change part of?" or which "Which track does artifact belong to?". In this way it offers a method of classifying and structuring one's continuous integration and delivery system and thereby facilitaring traceability and searchability. + +The nature of the described context can vary. The event consequently offers a high degree of flexibility in its description, and none of its member fields are mandatory. Instead they can picked and mixed to fit the situation. + +## Data Members +### data.product +__Type:__ String +__Required:__ No +__Description:__ A product context which other events can relate to (e.g. "This activity is part of the Product X continuous integration system."). + + +### data.product +__Type:__ String +__Required:__ No +__Description:__ A project context which other events can relate to (e.g. "This test is part of the Killer Feature project."). + +### data.program +__Type:__ String +__Required:__ No +__Description:__ A program context which other events can relate to (e.g. "This source change was made for the Zero Bugs program."). + +### data.track +__Type:__ String +__Required:__ No +__Description:__ A track context which other events can relate to (e.g. "This feature was implemented in the Customer X Adaptations track."). + +### data.version +__Type:__ String +__Required:__ No +__Description:__ A version context which other events can relate to. This member SHOULD be used in tandem with one of the other optional members - a version by itself is not very informative. + +## Examples +* [Simple example](https://github.com/Ericsson/eiffel-examples/blob/master/events/EiffelFlowContextDefinedEvent/simple.json) \ No newline at end of file From 6c4a91d33b31a7b06c5835e844cccae290ebe73c Mon Sep 17 00:00:00 2001 From: Daniel Stahl Date: Mon, 13 Jun 2016 13:49:33 +0200 Subject: [PATCH 2/3] Fixed typo. --- eiffel-vocabulary/EiffelFlowContextDefinedEvent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md b/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md index 052ea234..e9f72254 100644 --- a/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md +++ b/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md @@ -10,7 +10,7 @@ __Required:__ No __Description:__ A product context which other events can relate to (e.g. "This activity is part of the Product X continuous integration system."). -### data.product +### data.project __Type:__ String __Required:__ No __Description:__ A project context which other events can relate to (e.g. "This test is part of the Killer Feature project."). From 6292ef135467ef84614ec601b274e54b8be7ca34 Mon Sep 17 00:00:00 2001 From: Daniel Stahl Date: Mon, 13 Jun 2016 15:06:24 +0200 Subject: [PATCH 3/3] Fixed typo --- eiffel-vocabulary/EiffelFlowContextDefinedEvent.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md b/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md index e9f72254..bc9349d8 100644 --- a/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md +++ b/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md @@ -1,5 +1,5 @@ # EiffelFlowContextDefined -The EiffelFlowContextDefined describes the context of other events, answering questions such as "Which project is change part of?" or which "Which track does artifact belong to?". In this way it offers a method of classifying and structuring one's continuous integration and delivery system and thereby facilitaring traceability and searchability. +The EiffelFlowContextDefined describes the context of other events, answering questions such as "Which project is change part of?" or "Which track does artifact belong to?". In this way it offers a method of classifying and structuring one's continuous integration and delivery system and thereby facilitaring traceability and searchability. The nature of the described context can vary. The event consequently offers a high degree of flexibility in its description, and none of its member fields are mandatory. Instead they can picked and mixed to fit the situation. @@ -9,7 +9,6 @@ __Type:__ String __Required:__ No __Description:__ A product context which other events can relate to (e.g. "This activity is part of the Product X continuous integration system."). - ### data.project __Type:__ String __Required:__ No