Add glossary #237
Add glossary #237
Conversation
eiffel-syntax-and-usage/glossary.md
Outdated
| - [EiffelTestCaseFinishedEvent](../eiffel-vocabulary/EiffelTestCaseFinishedEvent.md) | ||
|
|
||
| ### Artifact | ||
| _Artifacts_ are items or software packages generated in a CI/CD [pipeline](#pipeline), for example a built binary or a Docker image. An artifact should be possible to identify using a purl (package URL). An artifact is often the subject of a test executed or a delivery performed within a CI/CD [pipeline](#pipeline). |
There was a problem hiding this comment.
This definition is enough, but maybe we could add that artifacts aren't always only things that will be included in products?
They can also be test artifacts, i.e. artifacts only created to be useful in some specific test scenario. For example, when product software is combined with testing harnesses. Such artifacts are also defined by Baselines to record what versions of testing harness software were used.
There was a problem hiding this comment.
Agreed. Will add something along those lines.
| #### Examples of events related to artifacts: | ||
| - [EiffelArtifactCreatedEvent](../eiffel-vocabulary/EiffelArtifactCreatedEvent.md) | ||
|
|
||
| ### Composition |
There was a problem hiding this comment.
Good definition!
As with Artifacts, we could add a comment/example of how Compositions/Baselines can be used to record test environments as well as product hierarchies.
There was a problem hiding this comment.
Yes, will do.
eiffel-syntax-and-usage/glossary.md
Outdated
| - [EiffelEnvironmentDefinedEvent](../eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ||
|
|
||
| ### Event | ||
| An Eiffel _event_ is a broadcast notification telling any consumer about an event occurring in the CI/CD [pipeline](#pipeline). |
There was a problem hiding this comment.
Again, good definition, I have heard many times that people still don't understand really what an event is/should be.
It is not a message sent intending to cause some side effect somewhere like a remote procedure call. It is just a notification to the world that something has happened. As such, an event should not contain information that is not directly associated with what happened, even if it is tempting to use them as carriers of general "system" type information.
There was a problem hiding this comment.
Good point. I'll elaborate a bit more on the event definition, and probably also add a link definition explaining a chain of events.
eiffel-syntax-and-usage/glossary.md
Outdated
|
|
||
| #### Examples of events related to artifacts: | ||
| - [EiffelArtifactCreatedEvent](../eiffel-vocabulary/EiffelArtifactCreatedEvent.md) | ||
|
|
||
| ### Composition | ||
| A _composition_ is an immutable grouping of specific versions of [artifacts](#artifact) and/or [source changes](#source-change). It is more or less the same as what is elsewhere sometimes referred to as a _baseline_, which can be explained as being a fixed reference point used for comparison. A composition is often defined with the purpose of enabling downstream [artifacts](#artifact) to be generated. | ||
| A _composition_ is an immutable grouping of specific versions of [artifacts](#artifact) and/or [source changes](#source-change). It is more or less the same as what is elsewhere sometimes referred to as a _baseline_, which can be explained as being a fixed reference point used for comparison. A composition is often defined with the purpose of enabling downstream artifacts to be generated. It gives full traceability on what software pieces that were used to generate the artifact, being it a product artifact, a test harness or some other kind of generated artifact. |
There was a problem hiding this comment.
"being it a product" should perhaps be rephrased to "be it a product"?
Applicable Issues
#234
Description of the Change
Adding a glossary of terms used in event definitions and documentation.
Alternate Designs
Benefits
Easier to read documentation and to make it homogenous
Possible Drawbacks
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: Emil Bäckmark [email protected]