Skip to content

Commit

Permalink
Add _name and _version fields to all definition files (#392)
Browse files Browse the repository at this point in the history
Up to now we've been relying on the directory structure and filenames
to determine the name and version of a definition file for an event
or some other type. There are advantages to this, but also the drawback
that it's clunky to work with and that the files always must remain in
this structure, i.e. you can't just transfer the contents of a file over
some channel or protocol and expect the receiver to be able to make
sense of it.

The new _name and _version key are introduced in the definition file
format and all existing files are updated to include them. We also add
a test that makes sure that the contents of those keys matches the
path to the file.
  • Loading branch information
magnusbaeck committed Jan 18, 2024
1 parent 1b9a637 commit da53778
Show file tree
Hide file tree
Showing 183 changed files with 572 additions and 192 deletions.
4 changes: 3 additions & 1 deletion definitions/EiffelActivityCanceledEvent/1.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityCanceledEvent
_version: 1.0.0
_abbrev: ActC
_description: The EiffelActivityCanceledEvent signals that a previously
triggered activity execution has been canceled _before it has started_.
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityCanceledEvent/1.1.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityCanceledEvent
_version: 1.1.0
_abbrev: ActC
_description: The EiffelActivityCanceledEvent signals that a previously
triggered activity execution has been canceled _before it has started_.
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityCanceledEvent/2.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityCanceledEvent
_version: 2.0.0
_abbrev: ActC
_description: The EiffelActivityCanceledEvent signals that a previously
triggered activity execution has been canceled _before it has started_.
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityCanceledEvent/3.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityCanceledEvent
_version: 3.0.0
_abbrev: ActC
_description: The EiffelActivityCanceledEvent signals that a previously
triggered activity execution has been canceled _before it has started_.
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityCanceledEvent/3.1.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityCanceledEvent
_version: 3.1.0
_abbrev: ActC
_description: The EiffelActivityCanceledEvent signals that a previously
triggered activity execution has been canceled _before it has started_.
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityCanceledEvent/3.2.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityCanceledEvent
_version: 3.2.0
_abbrev: ActC
_description: The EiffelActivityCanceledEvent signals that a previously
triggered activity execution has been canceled _before it has started_.
Expand Down
2 changes: 2 additions & 0 deletions definitions/EiffelActivityCanceledEvent/4.0.0.yml
Expand Up @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityCanceledEvent
_version: 4.0.0
_abbrev: ActC
_description: The EiffelActivityCanceledEvent signals that a previously
triggered activity execution has been canceled _before it has started_.
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityFinishedEvent/1.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityFinishedEvent
_version: 1.0.0
_abbrev: ActF
_description: The EiffelActivityFinishedEvent declares that a previously
started activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md)
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityFinishedEvent/1.1.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityFinishedEvent
_version: 1.1.0
_abbrev: ActF
_description: The EiffelActivityFinishedEvent declares that a previously
started activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md)
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityFinishedEvent/2.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityFinishedEvent
_version: 2.0.0
_abbrev: ActF
_description: The EiffelActivityFinishedEvent declares that a previously
started activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md)
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityFinishedEvent/3.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityFinishedEvent
_version: 3.0.0
_abbrev: ActF
_description: The EiffelActivityFinishedEvent declares that a previously
started activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md)
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityFinishedEvent/3.1.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityFinishedEvent
_version: 3.1.0
_abbrev: ActF
_description: The EiffelActivityFinishedEvent declares that a previously
started activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md)
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityFinishedEvent/3.2.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityFinishedEvent
_version: 3.2.0
_abbrev: ActF
_description: The EiffelActivityFinishedEvent declares that a previously
started activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md)
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityFinishedEvent/3.3.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityFinishedEvent
_version: 3.3.0
_abbrev: ActF
_description: The EiffelActivityFinishedEvent declares that a previously
started activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md)
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityStartedEvent/1.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityStartedEvent
_version: 1.0.0
_abbrev: ActS
_description: The EiffelActivityStartedEvent declares that a previously
triggered activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md))
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityStartedEvent/1.1.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityStartedEvent
_version: 1.1.0
_abbrev: ActS
_description: The EiffelActivityStartedEvent declares that a previously
triggered activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md))
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityStartedEvent/2.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityStartedEvent
_version: 2.0.0
_abbrev: ActS
_description: The EiffelActivityStartedEvent declares that a previously
triggered activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md))
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityStartedEvent/3.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityStartedEvent
_version: 3.0.0
_abbrev: ActS
_description: The EiffelActivityStartedEvent declares that a previously
triggered activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md))
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityStartedEvent/4.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityStartedEvent
_version: 4.0.0
_abbrev: ActS
_description: The EiffelActivityStartedEvent declares that a previously
triggered activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md))
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityStartedEvent/4.1.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityStartedEvent
_version: 4.1.0
_abbrev: ActS
_description: The EiffelActivityStartedEvent declares that a previously
triggered activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md))
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityStartedEvent/4.2.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityStartedEvent
_version: 4.2.0
_abbrev: ActS
_description: The EiffelActivityStartedEvent declares that a previously
triggered activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md))
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityStartedEvent/4.3.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityStartedEvent
_version: 4.3.0
_abbrev: ActS
_description: The EiffelActivityStartedEvent declares that a previously
triggered activity (declared by [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md))
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityTriggeredEvent/1.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityTriggeredEvent
_version: 1.0.0
_abbrev: ActT
_description: |-
The EiffelActivityTriggeredEvent declares that a certain activity - typically a build, test or analysis activity - has been triggered by some factor. Note that this is crucially different from the activity execution having _started_ (as declared by [EiffelActivityStartedEvent](./EiffelActivityStartedEvent.md)).
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityTriggeredEvent/1.1.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityTriggeredEvent
_version: 1.1.0
_abbrev: ActT
_description: |-
The EiffelActivityTriggeredEvent declares that a certain activity - typically a build, test or analysis activity - has been triggered by some factor. Note that this is crucially different from the activity execution having _started_ (as declared by [EiffelActivityStartedEvent](./EiffelActivityStartedEvent.md)).
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityTriggeredEvent/2.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityTriggeredEvent
_version: 2.0.0
_abbrev: ActT
_description: |-
The EiffelActivityTriggeredEvent declares that a certain activity - typically a build, test or analysis activity - has been triggered by some factor. Note that this is crucially different from the activity execution having _started_ (as declared by [EiffelActivityStartedEvent](./EiffelActivityStartedEvent.md)).
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityTriggeredEvent/3.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityTriggeredEvent
_version: 3.0.0
_abbrev: ActT
_description: |-
The EiffelActivityTriggeredEvent declares that a certain activity - typically a build, test or analysis activity - has been triggered by some factor. Note that this is crucially different from the activity execution having _started_ (as declared by [EiffelActivityStartedEvent](./EiffelActivityStartedEvent.md)).
Expand Down
4 changes: 3 additions & 1 deletion definitions/EiffelActivityTriggeredEvent/4.0.0.yml
@@ -1,4 +1,4 @@
# Copyright 2017-2023 Ericsson AB and others.
# Copyright 2017-2024 Ericsson AB and others.
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -14,6 +14,8 @@
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_name: EiffelActivityTriggeredEvent
_version: 4.0.0
_abbrev: ActT
_description: |-
The EiffelActivityTriggeredEvent declares that a certain activity - typically a build, test or analysis activity - has been triggered by some factor. Note that this is crucially different from the activity execution having _started_ (as declared by [EiffelActivityStartedEvent](./EiffelActivityStartedEvent.md)).
Expand Down

0 comments on commit da53778

Please sign in to comment.