From a162a02536c966f1481b1100274c03c7776db740 Mon Sep 17 00:00:00 2001 From: Jakob Meng Date: Tue, 15 Mar 2022 15:29:42 +0100 Subject: [PATCH] Added warning about the upcoming release and its breaking changes Change-Id: I729df817e9893abb483d7397359e23026adbb4ff --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d6f17455..62c10455 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,16 @@ This repo hosts the `openstack.cloud` Ansible Collection. The collection includes the Openstack modules and plugins supported by Openstack community to help the management of Openstack infrastructure. +:warning: **WARNING:** +This collection is currently being ported to the upcoming OpenStack SDK 1.\* release. SDK version 1.\* introduces +numerous API changes which break backward compatibility with previous 0.\* releases. Since keeping a single collection +release compatible with both SDK series is not sustainable, our collection codebase has been split: +Branch stable/1.0.0 and 1.\*.\* releases of the collection are compatible with previous OpenStack SDK 0.\* releases +only. The master branch and upcoming 2.\*.\* releases of this collection will be compatible with SDK 1.\* only. Both +branches will continue to be maintained for now. Patches from master will be backported to stable/1.0.0 on a best effort +basis but expect new features to be introduced in the master branch only. Contributions are welcome for both branches! +:warning: + ## Installation and Usage ### Installing dependencies