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

Print plugin versions #1264

Merged
merged 3 commits into from
Jan 8, 2021
Merged

Print plugin versions #1264

merged 3 commits into from
Jan 8, 2021

Conversation

mavam
Copy link
Member

@mavam mavam commented Jan 6, 2021

📔 Description

The version command now prints the plugin version as follows:

{
  "VAST": "2020.12.16-97-gced115d91-dirty",
  "CAF": "0.17.6",
  "Apache Arrow": "2.0.0",
  "PCAP": "libpcap version 1.9.1",
  "jemalloc": null,
  "plugins": {
    "example": "0.0.0-0"
  }
}

📝 Checklist

  • All user-facing changes have changelog entries.
  • The changes are reflected on docs.tenzir.com/vast, if necessary.
  • The PR description contains instructions for the reviewer, if necessary.

🎯 Review Instructions

In one shot.

@lava
Copy link
Member

lava commented Jan 6, 2021

I fear this might be a bit premature, we probably need to work on the version concept a bit more before presenting it so prominently to users.

In particular, there are several relevant versions: The ABI version, relevant when loading the plugin (changes all the time), the API version of the VAST plugin API that the plugin was written against, relevant when compiling the plugin (expected to change frequently while the feature is experimental, relatively stable afterwards) and the finally the package version of the plugin itself, irrelevant to vast but relevant to any downstream users of the plugin.

The current version is laid out like the last one, with patch and tweak versions, but internally it's more used like the first two. We should probably think about which of these we want to collect and display, and how.

Edit: If the version is intended to be one the first two, we should also specify the semantics of the individual fields. (ie. what does a "patch" version number mean for an ABI version?)

Copy link
Member

@dominiklohmann dominiklohmann left a comment

Choose a reason for hiding this comment

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

Let's move forward with this as is. We decided to do versioning checks for libvast API and ABI separately. This version number is only user-facing.

@mavam mavam merged commit 4464fab into master Jan 8, 2021
@mavam mavam deleted the story/ch21464 branch January 8, 2021 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants