Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add event categories #297

Merged
merged 10 commits into from
Oct 11, 2022
Merged

Add event categories #297

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e3a8a36
First idea of event categories
m-linner-ericsson Mar 16, 2022
fd7597e
Step version of Black
m-linner-ericsson Jul 27, 2022
76999f2
Add intro and give each category a color
m-linner-ericsson Jul 27, 2022
1f5653c
Reduce the amount of categories and add link in main README.md
m-linner-ericsson Jul 29, 2022
82f5d69
Change colors to improve listing readability
m-linner-ericsson Jul 29, 2022
eba9514
Fix abbreviation of IssueDefined
m-linner-ericsson Jul 29, 2022
7004091
Fixes after review
m-linner-ericsson Sep 14, 2022
018db12
Merge branch 'master' into add_event_categories
m-linner-ericsson Sep 14, 2022
ac29d08
Merge branch 'master' into add_event_categories
m-linner-ericsson Oct 7, 2022
fc7fda3
Update tox.ini
m-linner-ericsson Oct 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Visit [Eiffel Community](https://eiffel-community.github.io) to get started and
1. [Versioning](./eiffel-syntax-and-usage/versioning.md)
1. [Compositions and Validity Checking](./eiffel-syntax-and-usage/compositions-and-validity-checking.md)
1. [Security](./eiffel-syntax-and-usage/security.md)
1. [Event Categories](./eiffel-syntax-and-usage/event-categories.md)
1. The Eiffel Vocabulary
1. [EiffelActivityTriggeredEvent (ActT)](./eiffel-vocabulary/EiffelActivityTriggeredEvent.md)
1. [EiffelActivityCanceledEvent (ActC)](./eiffel-vocabulary/EiffelActivityCanceledEvent.md)
Expand Down
47 changes: 47 additions & 0 deletions eiffel-syntax-and-usage/event-categories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Event Categories

The Eiffel protocol specifies each event on its own. For convenience reasons the
protocol also provides a description on how to group them together in
categories. Use the following categories to group events together for ease of
talking about them or in reasoning. To make pictures with Eiffel events
consistent throughout the documentation we have assigned each category a color
picked from the
[Unicodes full list of geometric emoji](https://unicode.org/emoji/charts/full-emoji-list.html#geometric)
magnusbaeck marked this conversation as resolved.
Show resolved Hide resolved

| Category | Color |
|:-------------|:-----:|
| Activity | 🔵 |
| Artifact | 🔴 |
| Definition | 🟣 |
| Notification | 🟠 |
| Source | 🟢 |
| Test | 🟡 |
| Verdict | 🟤 |

The events and their categories.

| Category | Name | Abbreviation | Color |
|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------:|:-----:|
| Activity | [EiffelActivityCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityCanceledEvent.md) | ActC | 🔵 |
magnusbaeck marked this conversation as resolved.
Show resolved Hide resolved
| Activity | [EiffelActivityFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityFinishedEvent.md) | ActF | 🔵 |
| Activity | [EiffelActivityStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityStartedEvent.md) | ActS | 🔵 |
| Activity | [EiffelActivityTriggeredEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityTriggeredEvent.md) | ActT | 🔵 |
| Artifact | [EiffelArtifactCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactCreatedEvent.md) | ArtC | 🔴 |
| Artifact | [EiffelArtifactPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactPublishedEvent.md) | ArtP | 🔴 |
| Artifact | [EiffelArtifactReusedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactReusedEvent.md) | ArtR | 🔴 |
| Definition | [EiffelFlowContextDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | 🟣 |
| Definition | [EiffelCompositionDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | 🟣 |
| Definition | [EiffelEnvironmentDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | 🟣 |
| Definition | [EiffelIssueDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueDefinedEvent.md) | ID | 🟣 |
| Notification | [EiffelAnnouncementPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | 🟠 |
| Source | [EiffelSourceChangeCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md) | SCC | 🟢 |
| Source | [EiffelSourceChangeSubmittedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md) | SCS | 🟢 |
| Test | [EiffelTestCaseCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseCanceledEvent.md) | TCC | 🟡 |
| Test | [EiffelTestCaseFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseFinishedEvent.md) | TCF | 🟡 |
| Test | [EiffelTestCaseStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseStartedEvent.md) | TSS | 🟡 |
| Test | [EiffelTestCaseTriggeredEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md) | TCT | 🟡 |
| Test | [EiffelTestExecutionRecipeCollectionCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md) | TERCC | 🟡 |
| Test | [EiffelTestSuiteFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md) | TSF | 🟡 |
| Test | [EiffelTestSuiteStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md) | TSS | 🟡 |
| Verdict | [EiffelConfidenceLevelModifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md) | CLM | 🟤 |
| Verdict | [EiffelIssueVerifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueVerifiedEvent.md) | IV | 🟤 |
2 changes: 1 addition & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ basepython = python3

[testenv:black]
deps =
black==21.12b0
black==22.3.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've filed #307 for the Black error. Any PR that includes the patch above should reference that issue but ideally I think we should have a separate PR for this bug.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed with 018db12

commands = black --check --diff .

[testenv:flake8]
Expand Down