From 11a801d99446f4e6ec65b2f43074aa993418055a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20St=C3=A5hl?= Date: Wed, 12 Apr 2017 12:24:05 +0200 Subject: [PATCH] Updated versioning information in preparation of edition-bordeaux (#139) In preparation for tagging the Bordeaux edition, the editions list in versioning.md populated with additional names reserved for future use. The Bordeaux edition was updated with link to actual release tag. Furthermore, individual event type version tables were updated and a Changes column added to all version tables. --- eiffel-syntax-and-usage/versioning.md | 11 ++++++++--- eiffel-vocabulary/EiffelActivityCanceledEvent.md | 6 +++--- eiffel-vocabulary/EiffelActivityFinishedEvent.md | 6 +++--- eiffel-vocabulary/EiffelActivityStartedEvent.md | 6 +++--- eiffel-vocabulary/EiffelActivityTriggeredEvent.md | 6 +++--- eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md | 6 +++--- eiffel-vocabulary/EiffelArtifactCreatedEvent.md | 6 +++--- eiffel-vocabulary/EiffelArtifactPublishedEvent.md | 6 +++--- eiffel-vocabulary/EiffelArtifactReusedEvent.md | 6 +++--- eiffel-vocabulary/EiffelCompositionDefinedEvent.md | 6 +++--- .../EiffelConfidenceLevelModifiedEvent.md | 6 +++--- eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md | 6 +++--- eiffel-vocabulary/EiffelFlowContextDefinedEvent.md | 6 +++--- eiffel-vocabulary/EiffelIssueVerifiedEvent.md | 6 +++--- eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md | 6 +++--- eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md | 6 +++--- eiffel-vocabulary/EiffelTestCaseCanceledEvent.md | 6 +++--- eiffel-vocabulary/EiffelTestCaseFinishedEvent.md | 6 +++--- eiffel-vocabulary/EiffelTestCaseStartedEvent.md | 6 +++--- eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md | 6 +++--- ...EiffelTestExecutionRecipeCollectionCreatedEvent.md | 6 +++--- eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md | 6 +++--- eiffel-vocabulary/EiffelTestSuiteStartedEvent.md | 6 +++--- 23 files changed, 74 insertions(+), 69 deletions(-) diff --git a/eiffel-syntax-and-usage/versioning.md b/eiffel-syntax-and-usage/versioning.md index 2b087cd4..ca7fd39f 100644 --- a/eiffel-syntax-and-usage/versioning.md +++ b/eiffel-syntax-and-usage/versioning.md @@ -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. | diff --git a/eiffel-vocabulary/EiffelActivityCanceledEvent.md b/eiffel-vocabulary/EiffelActivityCanceledEvent.md index 67eace87..a8b8585b 100644 --- a/eiffel-vocabulary/EiffelActivityCanceledEvent.md +++ b/eiffel-vocabulary/EiffelActivityCanceledEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelActivityFinishedEvent.md b/eiffel-vocabulary/EiffelActivityFinishedEvent.md index 9f5fee77..31483284 100644 --- a/eiffel-vocabulary/EiffelActivityFinishedEvent.md +++ b/eiffel-vocabulary/EiffelActivityFinishedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelActivityStartedEvent.md b/eiffel-vocabulary/EiffelActivityStartedEvent.md index 65172f4a..03e95875 100644 --- a/eiffel-vocabulary/EiffelActivityStartedEvent.md +++ b/eiffel-vocabulary/EiffelActivityStartedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelActivityTriggeredEvent.md b/eiffel-vocabulary/EiffelActivityTriggeredEvent.md index ebb63fed..646146dd 100644 --- a/eiffel-vocabulary/EiffelActivityTriggeredEvent.md +++ b/eiffel-vocabulary/EiffelActivityTriggeredEvent.md @@ -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) diff --git a/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md b/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md index 4c19f933..0f4be132 100644 --- a/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md +++ b/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelArtifactCreatedEvent.md b/eiffel-vocabulary/EiffelArtifactCreatedEvent.md index 60646f9c..f75ef167 100644 --- a/eiffel-vocabulary/EiffelArtifactCreatedEvent.md +++ b/eiffel-vocabulary/EiffelArtifactCreatedEvent.md @@ -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) diff --git a/eiffel-vocabulary/EiffelArtifactPublishedEvent.md b/eiffel-vocabulary/EiffelArtifactPublishedEvent.md index c68cea2f..73cd6e05 100644 --- a/eiffel-vocabulary/EiffelArtifactPublishedEvent.md +++ b/eiffel-vocabulary/EiffelArtifactPublishedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelArtifactReusedEvent.md b/eiffel-vocabulary/EiffelArtifactReusedEvent.md index ab530e6d..70382bd3 100644 --- a/eiffel-vocabulary/EiffelArtifactReusedEvent.md +++ b/eiffel-vocabulary/EiffelArtifactReusedEvent.md @@ -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) diff --git a/eiffel-vocabulary/EiffelCompositionDefinedEvent.md b/eiffel-vocabulary/EiffelCompositionDefinedEvent.md index c9eef753..c9936e29 100644 --- a/eiffel-vocabulary/EiffelCompositionDefinedEvent.md +++ b/eiffel-vocabulary/EiffelCompositionDefinedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md b/eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md index 5212d9e1..ff332dbc 100644 --- a/eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md +++ b/eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md b/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md index 684777ca..e28601ef 100644 --- a/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md +++ b/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md @@ -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) diff --git a/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md b/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md index 43c11118..d10ea7aa 100644 --- a/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md +++ b/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelIssueVerifiedEvent.md b/eiffel-vocabulary/EiffelIssueVerifiedEvent.md index a2cc7250..a0a8e083 100644 --- a/eiffel-vocabulary/EiffelIssueVerifiedEvent.md +++ b/eiffel-vocabulary/EiffelIssueVerifiedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md b/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md index a626164e..2c296a0e 100644 --- a/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md +++ b/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md @@ -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) diff --git a/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md b/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md index 8574314a..70920b20 100644 --- a/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md +++ b/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelTestCaseCanceledEvent.md b/eiffel-vocabulary/EiffelTestCaseCanceledEvent.md index 49bf1fa9..db42d3dc 100644 --- a/eiffel-vocabulary/EiffelTestCaseCanceledEvent.md +++ b/eiffel-vocabulary/EiffelTestCaseCanceledEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelTestCaseFinishedEvent.md b/eiffel-vocabulary/EiffelTestCaseFinishedEvent.md index 99b1cc10..fb4fce7a 100644 --- a/eiffel-vocabulary/EiffelTestCaseFinishedEvent.md +++ b/eiffel-vocabulary/EiffelTestCaseFinishedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelTestCaseStartedEvent.md b/eiffel-vocabulary/EiffelTestCaseStartedEvent.md index 88abeed5..3ab54791 100644 --- a/eiffel-vocabulary/EiffelTestCaseStartedEvent.md +++ b/eiffel-vocabulary/EiffelTestCaseStartedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md b/eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md index 75c90ef7..ce9cb1ab 100644 --- a/eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md +++ b/eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md b/eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md index 12739efe..3d616805 100644 --- a/eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md +++ b/eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md @@ -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) diff --git a/eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md b/eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md index 528ee969..75be669a 100644 --- a/eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md +++ b/eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md @@ -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) \ No newline at end of file diff --git a/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md index 66a5abb5..2c01f8f0 100644 --- a/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md +++ b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md @@ -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) \ No newline at end of file