Skip to content

Commit 11a801d

Browse files
d-stahl-ericssond-stahl-ericsson
authored
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.
1 parent 316f2b1 commit 11a801d

23 files changed

+74
-69
lines changed

‎eiffel-syntax-and-usage/versioning.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,12 @@ The independent versioning of event types, as opposed to a protocol-wide version
2424

2525
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.
2626

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

‎eiffel-vocabulary/EiffelActivityCanceledEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ __Required:__ No
2525
__Description:__ Any human readable information as to the reason for dequeueing.
2626

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

3232
## Examples
3333
* [Simple example](../examples/events/EiffelActivityCanceledEvent/simple.json)

‎eiffel-vocabulary/EiffelActivityFinishedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ __Required:__ Yes
5757
__Description:__ The URI at which the log can be retrieved.
5858

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

6464
## Examples
6565
* [Simple example](../examples/events/EiffelActivityFinishedEvent/simple.json)

‎eiffel-vocabulary/EiffelActivityStartedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ __Required:__ Yes
4040
__Description:__ The URI at which the log can be retrieved.
4141

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

4747
## Examples
4848
* [Simple example](../examples/events/EiffelActivityStartedEvent/simple.json)

‎eiffel-vocabulary/EiffelActivityTriggeredEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ __Legal values:__ MANUAL, SEMI_AUTOMATED, AUTOMATED, OTHER
5959
__Description:__ The type of execution (often related to, but ultimately separate from, __data.triggers.type__).
6060

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

6666
## Examples
6767
* [Simple example](../examples/events/EiffelActivityTriggeredEvent/simple.json)

‎eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ __Legal values:__ MINOR, MAJOR, CRITICAL, BLOCKER, CLOSED, CANCELED
4141
__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.
4242

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

4848
## Examples
4949
* [Simple example](../examples/events/EiffelAnnouncementPublishedEvent/simple.json)

‎eiffel-vocabulary/EiffelArtifactCreatedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,9 @@ __Required:__ No
115115
__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.
116116

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

122122
## Examples
123123
* [Simple example](../examples/events/EiffelArtifactCreatedEvent/simple.json)

‎eiffel-vocabulary/EiffelArtifactPublishedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ __Required:__ Yes
4040
__Description:__ The URI at which the artifact can be retrieved.
4141

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

4747
## Examples
4848
* [Simple example](../examples/events/EiffelArtifactPublishedEvent/simple.json)

‎eiffel-vocabulary/EiffelArtifactReusedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ The event has no data members, but solely relies on its two required link types
2323
## Data Members
2424

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

3030
## Examples
3131
* [Simple example](../examples/events/EiffelArtifactReusedEvent/simple.json)

‎eiffel-vocabulary/EiffelCompositionDefinedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ __Required:__ No
3030
__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.
3131

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

3737
## Examples
3838
* [Simple example](../examples/events/EiffelCompositionDefinedEvent/simple.json)

‎eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ __Required:__ No
6161
__Description:__ Any group, such as a development team, committee or test group, to which the issuer belongs.
6262

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

6868
## Examples
6969
* [Simple example](../examples/events/EiffelConfidenceLevelModifiedEvent/simple.json)

‎eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ __Required:__ No
5757
__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.
5858

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

6464
## Examples
6565
* [URI example](../examples/events/EiffelEnvironmentDefinedEvent/uri.json)

‎eiffel-vocabulary/EiffelFlowContextDefinedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ __Required:__ No
4747
__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.
4848

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

5454
## Examples
5555
* [Simple example](../examples/events/EiffelFlowContextDefinedEvent/simple.json)

‎eiffel-vocabulary/EiffelIssueVerifiedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ FAILURE signifies that verification of the issue failed.
5555
INCONCLUSIVE signifies that the verification of the issue was inconclusive.
5656

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

6262
## Examples
6363
* [Simple example](../examples/events/EiffelIssueVerifiedEvent/simple.json)

‎eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,9 +209,9 @@ __Required:__ Yes
209209
__Description:__ The URI of the repo.
210210

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

216216
## Examples
217217
* [Simple example](../examples/events/EiffelSourceChangeCreatedEvent/simple.json)

‎eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,9 @@ __Required:__ Yes
144144
__Description:__ The URI of the repo.
145145

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

151151
## Examples
152152
* [Simple example](../examples/events/EiffelSourceChangeSubmittedEvent/simple.json)

‎eiffel-vocabulary/EiffelTestCaseCanceledEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ __Required:__ No
2525
__Description:__ Any human readable information as to the reason for dequeueing.
2626

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

3232
## Examples
3333
* [Simple example](../examples/events/EiffelTestCaseCanceledEvent/simple.json)

‎eiffel-vocabulary/EiffelTestCaseFinishedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ __Required:__ Yes
8484
__Description:__ The URI at which the log can be retrieved.
8585

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

9191
## Examples
9292
* [Simple example](../examples/events/EiffelTestCaseFinishedEvent/simple.json)

‎eiffel-vocabulary/EiffelTestCaseStartedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ __Required:__ Yes
4040
__Description:__ The URI at which the log can be retrieved.
4141

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

4747
## Examples
4848
* [Simple example](../examples/events/EiffelTestCaseStartedEvent/simple.json)

‎eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ __Required:__ Yes
9494
__Description:__ The value of the parameter.
9595

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

101101
## Examples
102102
* [Simple example](../examples/events/EiffelTestCaseTriggeredEvent/simple.json)

‎eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,9 @@ __Required:__ Yes
118118
__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.
119119

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

125125
## Examples
126126
* [Example using data.batches](../examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batches.json)

‎eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ __Required:__ Yes
6767
__Description:__ The URI at which the log can be retrieved.
6868

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

7474
## Examples
7575
* [Simple example](../examples/events/EiffelTestSuiteFinishedEvent/simple.json)

‎eiffel-vocabulary/EiffelTestSuiteStartedEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ __Required:__ Yes
5353
__Description:__ The URI at which the log can be retrieved.
5454

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

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

0 commit comments

Comments
 (0)