Skip to content

Use a unique version for plugins #1764

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

Merged
merged 3 commits into from
Jul 9, 2021

Conversation

dominiklohmann
Copy link
Member

@dominiklohmann dominiklohmann commented Jul 8, 2021

📔 Description

This changes plugin versions to be set automatically by the VASTRegisterPlugin CMake function. A plugin version consists of three parts:

  • The CMake project version of the plugin
  • The Git revision of the last commit that touched the plugin
  • A dirty suffix for uncommited changes to the plugins

The VAST_REGISTER_PLUGIN macro no longer takes the plugin version in the C++ code, which may require plugins to be updated.

📝 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

Run locally to test the dirty indicator and that rebuilds pick up changes without reconfiguration.

@dominiklohmann dominiklohmann added the feature New functionality label Jul 8, 2021
@dominiklohmann dominiklohmann requested a review from tobim July 8, 2021 11:49
@dominiklohmann dominiklohmann force-pushed the story/ch26432/uniuqe-plugin-version branch 2 times, most recently from d86a5ff to cf69006 Compare July 8, 2021 16:34
Copy link
Member

@tobim tobim left a comment

Choose a reason for hiding this comment

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

This doesn't work with the static binary build yet, because .git is not available when building with Nix. Let's talk about this tomorrow.

{
  "VAST": "2021.06.24-94-gcf69006dd9-dirty",
  "VAST Build Tree Hash": "affe98910aab0b51579bd156300f7665",
  "CAF": "0.17.6",
  "Apache Arrow": "4.0.1",
  "jemalloc": "5.2.1-0-gea6b3e973b477b8061e0076bb257dbd7f3faa756",
  "plugins": {
    "example-analyzer": "0.1",
    "pcap": "unspecified"
  }
}

@dominiklohmann
Copy link
Member Author

This doesn't work with the static binary build yet, because .git is not available when building with Nix. Let's talk about this tomorrow.

We discussed this and agreed to do this in a separate PR.

This one still needs to be rebased after #1767 is merged.

Copy link
Member

@tobim tobim left a comment

Choose a reason for hiding this comment

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

Approving this now, but I think the example analyzer integration test needs a fix.

This changes plugin versions to be set automatically by the
`VASTRegisterPlugin` CMake function. A plugin version consists of three
parts:
- The CMake project version of the plugin
- The Git revision of the last commit that touched the plugin
- A `dirty` suffix for uncommited changes to the plugins

The `VAST_REGISTER_PLUGIN` macro no longer takes the plugin version in
the C++ code, which may require plugins to be updated.
@dominiklohmann dominiklohmann force-pushed the story/ch26432/uniuqe-plugin-version branch from cf69006 to 3899d5d Compare July 9, 2021 15:05
@dominiklohmann dominiklohmann merged commit 97b7435 into master Jul 9, 2021
@dominiklohmann dominiklohmann deleted the story/ch26432/uniuqe-plugin-version branch July 9, 2021 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants