Analytics plugin reports: should we use master or release branch?

[Ahmed Elwan]

Hi team,

I’m working on enabling the Kill Bill Analytics plugin and I have a question regarding which reports SQL files should be used for the latest released version of the plugin.

I noticed that reports exist in two different locations:

• Master branch
  https://github.com/killbill/killbill-analytics-plugin/tree/master/reports

• Release-specific path (e.g. analytics-plugin-8.1.3)
  https://github.com/killbill/killbill-analytics-plugin/tree/analytics-plugin-8.1.3/src/main/resources

There are noticeable differences between the reports in these locations.
After reviewing them, it looks like the reports on master are more recently updated, while the reports included in the release branch seem to have some issues.

My questions are:

1. For a given released version of the Analytics plugin, should we use the reports from the release tag/branch or from master?

2. Is the master/reports directory intended mainly for development or future plugin versions?

3. Are there any known compatibility or stability concerns if reports from master are used with a released plugin version?

Any guidance or recommended best practices would be greatly appreciated 🙏

Thanks in advance!

Ahmed

[Reshma Bidikar]

Hello Ahmed,

You are correct, the reports from the master branch are the latest and should be used. I have now released version 8.1.4 of the plugin. This now has the same reports as in the master branch: https://github.com/killbill/killbill-analytics-plugin/tree/analytics-plugin-8.1.4/reports

With regards to your questions:

1. For a given released version of the Analytics plugin, should we use the reports from the release tag/branch or from master?

 You should use the reports from the release tag/branch.

1. Is the master/reports directory intended mainly for development or future plugin versions?

 Yes

1. Are there any known compatibility or stability concerns if reports from master are used with a released plugin version?

No, the reports from master should generally work with earlier plugin versions. 

Hope this helps!

Regards,

Reshma

[Ahmed Elwan]

Thank you very much, Reshma, for your support.

Best Regards, 

Ahmed