Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
33 changes: 33 additions & 0 deletions eiffel-vocabulary/EiffelFlowContextDefinedEvent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# EiffelFlowContextDefined
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.

## 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.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.").

### 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)