-
Notifications
You must be signed in to change notification settings - Fork 59
/
3.3.0.yml
147 lines (147 loc) · 5.62 KB
/
3.3.0.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# Copyright 2017-2022 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");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
---
$schema: http://json-schema.org/draft-04/schema#
_abbrev: ArtP
_description: The EiffelArtifactPublishedEvent declares that a software
artifact (declared by [EiffelArtifactCreatedEvent](./EiffelArtifactCreatedEvent.md))
has been published and is consequently available for retrieval at
one or more locations.
type: object
properties:
meta:
$ref: ../EiffelMetaProperty/3.1.0.yml
data:
type: object
properties:
locations:
_description: A list of locations at which the artifact may
be retrieved.
type: array
items:
type: object
properties:
name:
_description: Identifies the name of the file within
the artifact for which this location provides the URI.
Must correspond to a __data.fileInformation.name__
value in the [EiffelArtifactCreatedEvent](./EiffelArtifactCreatedEvent.md)
connected via the __ARTIFACT__ link.
type: string
type:
_description: |-
The type of location. May be used by (automated) readers to understand the method of retrieval, particularly with regards to authentication.
ARTIFACTORY signifies an [Artifactory](https://www.jfrog.com/artifactory/)
NEXUS signifies a [Nexus](http://www.sonatype.org/nexus/)
PLAIN signifies a plain HTTP GET request.
OTHER signifies other methods of retrieval. Note that using this type likely requires some foreknowledge on part of the reader in order to fetch the artifact.
type: string
enum:
- ARTIFACTORY
- NEXUS
- PLAIN
- OTHER
uri:
_description: The URI at which the artifact can be retrieved.
type: string
required:
- type
- uri
additionalProperties: false
customData:
type: array
items:
$ref: ../EiffelCustomDataProperty/1.0.0.yml
required:
- locations
additionalProperties: false
links:
type: array
items:
$ref: ../EiffelEventLink/1.1.1.yml
required:
- meta
- data
- links
additionalProperties: false
_links:
ARTIFACT:
description: Identifies the artifact that was published.
required: true
multiple: false
targets:
any_type: false
types:
- EiffelArtifactCreatedEvent
CAUSE:
description: 'Identifies a cause of the event occurring. SHOULD
not be used in conjunction with __CONTEXT__: individual events
providing __CAUSE__ within a larger context gives rise to ambiguity.
It is instead recommended to let the root event of the context
declare __CAUSE__.'
required: false
multiple: true
targets:
any_type: true
types: []
CONTEXT:
description: Identifies the activity or test suite of which this
event constitutes a part.
required: false
multiple: false
targets:
any_type: false
types:
- EiffelActivityTriggeredEvent
- EiffelTestSuiteStartedEvent
FLOW_CONTEXT:
description: 'Identifies the flow context of the event: which is
the continuous integration and delivery flow in which this occurred
– e.g. which product, project, track or version this is applicable
to.'
required: false
multiple: true
targets:
any_type: false
types:
- EiffelFlowContextDefinedEvent
_history:
- version: 3.3.0
introduced_in: '[edition-arica](../../../tree/edition-arica)'
changes: Add schema URL to the meta object (see [Issue 280](https://github.com/eiffel-community/eiffel/issues/280)).
- version: 3.2.0
introduced_in: '[edition-lyon](../../../tree/edition-lyon)'
changes: Add links.domainId member (see [Issue 233](https://github.com/eiffel-community/eiffel/issues/233)).
- version: 3.1.0
introduced_in: '[edition-paris](../../../tree/edition-paris)'
changes: Added name qualifier for artifact locations (see [Issue
248](https://github.com/eiffel-community/eiffel/issues/248))
- version: 3.0.0
introduced_in: '[edition-agen](../../../tree/edition-agen)'
changes: Improved information integrity protection (see [Issue
185](https://github.com/eiffel-community/eiffel/issues/185)).
- version: 2.0.0
introduced_in: '[dc5ec6f](../../../blob/dc5ec6fb87e293eeffe88fdafe698eec0f5a2c89/eiffel-vocabulary/EiffelArtifactPublishedEvent.md)'
changes: Introduced purl identifiers instead of GAVs (see [Issue
182](https://github.com/eiffel-community/eiffel/issues/182))
- version: 1.1.0
introduced_in: '[edition-toulouse](../../../tree/edition-toulouse)'
changes: Multiple links of type FLOW_CONTEXT allowed.
- version: 1.0.0
introduced_in: '[edition-bordeaux](../../../tree/edition-bordeaux)'
changes: Initial version.
_examples:
- title: Simple example
url: ../examples/events/EiffelArtifactPublishedEvent/simple.json