summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2017-05-24 13:11:57 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2017-05-24 13:11:57 +0200
commit5ea7f8431fc14e4d33c2fe0babd0401f2543f2c6 (patch)
tree9fdb4e8265676b9f9f3155ca0daf214b9de5bf9a
parentf2b94a7f2cef6ca7d5e6d87494ed3e90426d8d2b (diff)
downloadgitlab-5ea7f8431fc14e4d33c2fe0babd0401f2543f2c6.tar.gz
add a warning about the upcoming v4 as default
-rw-r--r--RELEASE_NOTES.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst
index 3c6b592..6e080c7 100644
--- a/RELEASE_NOTES.rst
+++ b/RELEASE_NOTES.rst
@@ -16,6 +16,12 @@ Changes from 0.20 to 0.21
Be aware that the python-gitlab API for v4 objects might change in the next
releases.
+ .. warning::
+
+ Consider defining explicitly which API version you want to use in the
+ configuration files or in your ``gitlab.Gitlab`` instances. The default
+ will change from v3 to v4 soon.
+
* Several methods have been deprecated in the ``gitlab.Gitlab`` class:
+ ``credentials_auth()`` is deprecated and will be removed. Call ``auth()``.