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

Events violate the Eiffel specification #8

Open
magnusbaeck opened this issue Aug 4, 2020 · 0 comments
Open

Events violate the Eiffel specification #8

magnusbaeck opened this issue Aug 4, 2020 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@magnusbaeck
Copy link
Member

Description

The Eiffel events produced by this library don't follow the Eiffel specification. While they're syntactically correct and pass the schema validation they have various issues:

  • The data.gitIdentifier.commitId field contains the change id instead of the commit id. The spec says that this field should contain "the commit identity (hash) of the change", and the change id doesn't fit that bill (e.g. because it isn't unique).
  • The data.gitIdentifier.repoUri field contains the URL of the Gerrit change, e.g. https://gerrit.example.com/c/name/of/repo/+/123456. The spec says that this field should contain "the URI of the repository containing the change", i.e. something you can give to a git clone command.
  • The meta.source fields are abused to include the change URL and the name of the change uploader.

Motivation

The produced events should follow the specification. I think the spec contains some ambiguities in the descriptions of the data.gitIdentifier fields but the things reported here shouldn't be controversial.

Possible Drawbacks

Changing this should be considered a backwards-incompatible change.

@magnusbaeck magnusbaeck added the bug Something isn't working label Aug 4, 2020
@magnusbaeck magnusbaeck self-assigned this Aug 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant