Update README.md to clarify plugin/opensearch version sync

jeroenhabets commented 11 months ago

Description

See NOTE: under Compatibility Matrix

As requested by @lukas-vlcek in https://github.com/aiven/prometheus-exporter-plugin-for-opensearch/issues/197 New commit w/ DCO and new PR - superseding #198 w/ some discussion.

[X] All my commits include DCO.
DCO stands for Developer Certificate of Origin and it is your declaration that your contribution is correctly attributed and licensed. Please read more about how to attach DCO to your commits here (spoiler alert: in most cases it is as simple as using -s option when doing git commit).
Please be aware that commits without DCO will cause failure of PR CI workflow and can not be merged.

lukas-vlcek commented 11 months ago

@jeroenhabets I think the DCO format is not correct, the email address should be in angle brackets.

Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>

lukas-vlcek commented 11 months ago

Thanks @jeroenhabets

The CI check was failing on unrecognised sign-off format. I am merging this commit anyway as the intention to provide the sign-off was clearly demonstrated by the contributor and the fact that its format was not correctly recognised is rather an issue of "git action" and CONTRIBUTING.md documentation.

See below for DCO action error message:

Run tim-actions/dco@v1.1.0
Error: The SoB (DCO) check failed

  1956efe1b26230b7ea962[4](https://github.com/aiven/prometheus-exporter-plugin-for-opensearch/actions/runs/5659671404/job/15421360485#step:3:5)22a[6](https://github.com/aiven/prometheus-exporter-plugin-for-opensearch/actions/runs/5659671404/job/15421360485#step:3:7)16bddecc30[7](https://github.com/aiven/prometheus-exporter-plugin-for-opensearch/actions/runs/5659671404/job/15421360485#step:3:8)097    The sign-off is missing.

  What should I do to fix it ?

  All proposed commits should include a Signed-off-by: <your-name> <your-email-address> line in their commit message.
  This is most conveniently done by using --signoff (-s) when running git commit.

There is no indication that the email address needs to be enclosed in angle brackets. Signed-off-by: <your-name> <your-email-address>

Aiven-Open / prometheus-exporter-plugin-for-opensearch

Update README.md to clarify plugin/opensearch version sync #204

Description