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.

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

Missing Eventname and Version in the YAML files #341

Closed
m-linner-ericsson opened this issue Dec 15, 2022 · 1 comment · Fixed by #392
Closed

Missing Eventname and Version in the YAML files #341

m-linner-ericsson opened this issue Dec 15, 2022 · 1 comment · Fixed by #392
Assignees

Comments

@m-linner-ericsson
Copy link
Member

Description

When programmatically reading the YAML files in the https://github.com/eiffel-community/eiffel/tree/master/definitions the only way to figure out the name and version is to look at the filename and path.

Motivation

Reading the file name and directory structure to figure out the event name is error pone and not straight forward.

Exemplification

In e.g https://github.com/eiffel-community/eiffel/blob/master/definitions/EiffelActivityTriggeredEvent/4.2.0.yml you can't explicitly find the event name and version.

Benefits

Being able to programmatically read out the event name and version without having to look at the directory structure and filenames.

Possible Drawbacks

None that I can see

@magnusbaeck
Copy link
Member

One drawback of including this information in the file itself is that there could be inconsistencies between the path and the file contents. To mitigate this we could introduce a test that checks for such inconsistencies. This assumes that we want to keep the current filename convention, but I don't think there are any good reasons for changing it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants