Changelogs and breaking changes

[abadger]

SUMMARY

Hi, I remember we talked and there was a thought that community.kubernetes was going to include backwards incompatible changes that hadn't gone through a deprecation cycle in ansible-2.9.x.

Is that the case still? If so, I just wanted to make sure those changes get shown in a changelog entry (and porting guide if you have one).

I don't know if you're planning to use the antsibull-changelog tool that @felixfontein has been developing to manage your changelogs. If you are, it has several change types which would end up in an automated, unified porting guide for ansible-2.10 if we can manage to get everything worked out on time.

i've cc'd him in case you want to discuss how that would work with him.

ISSUE TYPE

• Documentation Report

COMPONENT NAME

Changelog. Possibly Changelog.md

ANSIBLE VERSION

This is regarding ansible-2.10 and the community.kubernetes version that you're targeting for that.

[geerlingguy]

See related: #40

There are currently no backwards-incompatible changes (that I can think of... maybe before closing this out as 'done' @fabianvf and @willthames can fact-check me on that), and in #40 we plan on adopting the changelog generation tool you mentioned.

We've added some bug fixes, as well as new modules. 0.9.0 was identical to what was in Ansible 2.9. 0.10.0 added new k8s_* modules, and 0.11.0 added the new helm_* modules.

[geerlingguy]

was going to include backwards incompatible changes that hadn't gone through a deprecation cycle in ansible-2.9.x.

I think that may be referring to some architectural discussions that @fabianvf and I had specifically. None of those changes have been made yet, and we would definitely need to figure out a plan for how to roll out those changes correctly. The changes would mostly be in underlying code, so the interface of the collection would remain identical, and ideally, there would be no end-user difference whatsoever.

[geerlingguy]

Closing this and moving changelog-specific discussion over to #40 — for now there are no breaking changes planned, and I'm thinking we'll do a 0.11.1 (or maybe call it a 1.0.0 at some point?) with some of the minor bugfixes/performance improvements we've added since early May.