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
11 changes: 8 additions & 3 deletions eiffel-syntax-and-usage/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,12 @@ The independent versioning of event types, as opposed to a protocol-wide version

That being said, to facilitate compatibility and consistency, the Eiffel protocol as described in this repository is released in named and internally coherent _editions_. Each of these editions is represented as a GitHub [release](https://github.com/Ericsson/eiffel/releases). A history of Eiffel editions is available below.

| Edition | Tag |
| --------- | ------------------ |
| Bordeaux | _First edition. Not yet finished. Planned for end of [Drop 4](https://github.com/Ericsson/eiffel/milestone/4)._ |
| Edition | Tag | Changes |
| --------- | --------------------------------------------------- | ------------------------------------------------ |
| Arica | _Reserved for future use._ | |
| Lyon | _Reserved for future use._ | |
| Paris | _Reserved for future use._ | |
| Agen | _Reserved for future use._ | |
| Toulouse | _Reserved for future use._ | |
| Bordeaux | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial edition. |

6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelActivityCanceledEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ __Required:__ No
__Description:__ Any human readable information as to the reason for dequeueing.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelActivityCanceledEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelActivityFinishedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ __Required:__ Yes
__Description:__ The URI at which the log can be retrieved.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelActivityFinishedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelActivityStartedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ __Required:__ Yes
__Description:__ The URI at which the log can be retrieved.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelActivityStartedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelActivityTriggeredEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ __Legal values:__ MANUAL, SEMI_AUTOMATED, AUTOMATED, OTHER
__Description:__ The type of execution (often related to, but ultimately separate from, __data.triggers.type__).

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelActivityTriggeredEvent/simple.json)
Expand Down
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ __Legal values:__ MINOR, MAJOR, CRITICAL, BLOCKER, CLOSED, CANCELED
__Description:__ The severity of the announcement. The CLOSED and CANCELED values SHOULD only be used when following up a previous announcement, i.e. in conjunction with a __MODIFIED_ANNOUNCEMENT__ link.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelAnnouncementPublishedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelArtifactCreatedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,9 @@ __Required:__ No
__Description:__ Any (colloquial) name of the artifact. Unlike __data.gav__, this is not intended as an unambiguous identifier of the artifact, but as a descriptive and human readable name.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelArtifactCreatedEvent/simple.json)
Expand Down
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelArtifactPublishedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ __Required:__ Yes
__Description:__ The URI at which the artifact can be retrieved.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelArtifactPublishedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelArtifactReusedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ The event has no data members, but solely relies on its two required link types
## Data Members

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelArtifactReusedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelCompositionDefinedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ __Required:__ No
__Description:__ The version of the composition, if any. This is in a sense redundant, as relationships between compositions can be tracked via the __PREVIOUS_VERSION__ link type, but can be used for improved clarity and semantics.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelCompositionDefinedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ __Required:__ No
__Description:__ Any group, such as a development team, committee or test group, to which the issuer belongs.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelConfidenceLevelModifiedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ __Required:__ No
__Description:__ A URI identifying the environment description. This is the catch-all method of environment descriptions. Eiffel does not concern itself with the format or nature of the description, but merely points to its location.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [URI example](../examples/events/EiffelEnvironmentDefinedEvent/uri.json)
Expand Down
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelFlowContextDefinedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ __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.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelFlowContextDefinedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelIssueVerifiedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ FAILURE signifies that verification of the issue failed.
INCONCLUSIVE signifies that the verification of the issue was inconclusive.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelIssueVerifiedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,9 +209,9 @@ __Required:__ Yes
__Description:__ The URI of the repo.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelSourceChangeCreatedEvent/simple.json)
Expand Down
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,9 @@ __Required:__ Yes
__Description:__ The URI of the repo.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelSourceChangeSubmittedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelTestCaseCanceledEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ __Required:__ No
__Description:__ Any human readable information as to the reason for dequeueing.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelTestCaseCanceledEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelTestCaseFinishedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ __Required:__ Yes
__Description:__ The URI at which the log can be retrieved.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelTestCaseFinishedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelTestCaseStartedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ __Required:__ Yes
__Description:__ The URI at which the log can be retrieved.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelTestCaseStartedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ __Required:__ Yes
__Description:__ The value of the parameter.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelTestCaseTriggeredEvent/simple.json)
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,9 @@ __Required:__ Yes
__Description:__ The UUID of the dependent execution (__data.batches.recipes.id__), i.e. the execution that shall be performed only after that of the dependency.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Example using data.batches](../examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batches.json)
Expand Down
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ __Required:__ Yes
__Description:__ The URI at which the log can be retrieved.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelTestSuiteFinishedEvent/simple.json)
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelTestSuiteStartedEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ __Required:__ Yes
__Description:__ The URI at which the log can be retrieved.

## Version History
| Version | Introducing Commit |
| --------- | ------------------ |
| 1.0.0 | _Current version_ |
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |

## Examples
* [Simple example](../examples/events/EiffelTestSuiteStartedEvent/simple.json)