Skip to content
This repository was archived by the owner on Oct 29, 2024. It is now read-only.

Implement CHANGELOG #499

Closed
sebito91 opened this issue Sep 7, 2017 · 8 comments
Closed

Implement CHANGELOG #499

sebito91 opened this issue Sep 7, 2017 · 8 comments

Comments

@sebito91
Copy link
Contributor

sebito91 commented Sep 7, 2017

Would be nice to cut releases on a regular cadence, adding this to track progress on a release cycle + process.

@hvdklauw
Copy link

Yeah, not sure now if I can upgrade to version 5 because there is nothing to indicate backwards compatibility

@aviau
Copy link
Collaborator

aviau commented Jan 15, 2018

@aviau
Copy link
Collaborator

aviau commented Jan 15, 2018

screenshot from 2018-01-15 15-15-53

@aviau
Copy link
Collaborator

aviau commented Jan 15, 2018

@hvdklauw the breaking change are well explained.

@RossBarnie
Copy link

Yes, the release explains the low-level detail of the change, but as a user of InfluxDB, and not a developer on it, I have no idea which versions of InfluxDB would be incompatible without trawling through various versions of InfluxDB's source code.

While the release does provide a good explanation of the changes, a Changelog, along with a clear indication of InfluxDB versions affected by any breaking changes, would be more immediately accessible and readable.

@aviau
Copy link
Collaborator

aviau commented Jan 25, 2018

influxdb-python is for programmers. If you use a program that uses influxbd-pyhton, this program should document what version of influxdb-python it supports.

@RossBarnie
Copy link

Ok, in that case let's look at it from a programmers' point of view. How do I know which versions of InfluxDB are no longer supported by the 5.0.0 version of influxdb-python? What versions of InfluxDB can I say I support to people who use my library which depends on influxdb-python? Of course I can go look for myself, the point is that if there's a single source of truth (ie in the Changelog), then you're saving X amount of time for every developer or sysadmin who just wants to know if it's safe to upgrade this library for a given version of InfluxDB. It provides value to the library and respects other developers' and sysadmins' time.

@aviau
Copy link
Collaborator

aviau commented Jan 25, 2018

How do I know which versions of InfluxDB are no longer supported by the 5.0.0 version of influxdb-python?

We don't even know ourselves. We only test against one version of influxdb at a time.

If we know that we break compatibility, it will be in the releases page I have linked to you.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants