<!--- Copyright 2017-2023 Ericsson AB. 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. ---> <!-- markdownlint-disable first-line-h1 --> <img src="./images/eiffel-protocol-logo.png" alt="Eiffel Protocol" width="350"/>

Eiffel Protocol

This repository contains the Eiffel protocol vocabulary, descriptions, guides and schemas. For implementations, architecture and community resources, visit the Eiffel Community.

About this repository

The contents of this repository are licensed under the Apache License 2.0.

To get involved, please see Code of Conduct and our contribution page.

About Eiffel

This repository forms part of the Eiffel Community. Eiffel is a protocol for technology agnostic machine-to-machine communication in continuous integration and delivery pipelines, aimed at securing scalability, flexibility and traceability. Eiffel is based on the concept of decentralized real time messaging, both to drive the continuous integration and delivery system and to document it.

Visit Eiffel Community to get started and get involved.

Contents

1. Introduction
   1. Introduction
   2. How to Propose Changes and Contribute
   3. Code of Conduct
2. Eiffel Syntax and Usage
   1. Eiffel Glossary
   2. Event Design Guidelines
   3. Event Structure
   4. The Meta Object
   5. The Links Object
   6. Versioning
   7. Compositions and Validity Checking
   8. Security
   9. Activity Linking
   10. Event Schemas
   11. Event Categories
   12. Eiffel and Cloud Events
3. The Eiffel Vocabulary
   1. EiffelActivityTriggeredEvent (ActT)
   2. EiffelActivityCanceledEvent (ActC)
   3. EiffelActivityStartedEvent (ActS)
   4. EiffelActivityFinishedEvent (ActF)
   5. EiffelArtifactCreatedEvent (ArtC)
   6. EiffelArtifactDeployedEvent (ArtD)
   7. EiffelArtifactPublishedEvent (ArtP)
   8. EiffelArtifactReusedEvent (ArtR)
   9. EiffelConfidenceLevelModifiedEvent (CLM)
   10. EiffelEnvironmentDefinedEvent (ED)
   11. EiffelCompositionDefinedEvent (CD)
   12. EiffelSourceChangeCreatedEvent (SCC)
   13. EiffelSourceChangeSubmittedEvent (SCS)
   14. EiffelFlowContextDefinedEvent (FCD)
   15. EiffelTestCaseTriggeredEvent (TCT)
   16. EiffelTestCaseCanceledEvent (TCC)
   17. EiffelTestCaseStartedEvent (TCS)
   18. EiffelTestCaseFinishedEvent (TCF)
   19. EiffelTestSuiteStartedEvent (TSS)
   20. EiffelTestSuiteFinishedEvent (TSF)
   21. EiffelIssueVerifiedEvent (IV)
   22. EiffelTestExecutionRecipeCollectionCreatedEvent (TERCC)
   23. EiffelAnnouncementPublishedEvent (AnnP)
   24. EiffelIssueDefinedEvent (ID)
4. Usage Examples
   1. Confidence Level Joining
   2. Delivery Interface
   3. Build Avoidance
   4. Pipeline Monitoring
   5. Test Execution
   6. Confidence Level for a Combination of Hardware and Software
   7. Reference Data Sets
      1. Default
5. Customization
   1. Custom Events
   2. Custom Data
6. Extensions
   1. Eiffel Operations Extension
7. Releases and Milestones
   1. Release process