Set minimum hvac version (#374)

* set hvac minimum to v1.1.0 * add changelog fragment * update user guide
ansible-collections · May 10, 2023 · eed0111 · eed0111
1 parent 3907644
commit eed0111
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/changelogs/fragments/324-minimum-hvac-version.yml b/changelogs/fragments/324-minimum-hvac-version.yml
@@ -0,0 +1,3 @@
+---
+breaking_changes:
+  - The minimum version of ``hvac`` for ``community.hashi_vault`` is now ``1.1.0`` (https://github.com/ansible-collections/community.hashi_vault/issues/324).
diff --git a/docs/docsite/rst/user_guide.rst b/docs/docsite/rst/user_guide.rst
@@ -29,13 +29,11 @@ The content in ``community.hashi_vault`` requires the `hvac <https://hvac.readth
 ``hvac`` version specifics
 --------------------------
 
-In general, we recommend using the latest version of ``hvac`` that is supported for your given Python version because that is what we test against. Where possible we will try to list version-specific restrictions here, but this list may not be exhaustive.
+In general, we recommend using the latest version of ``hvac`` that is supported for your given Python version because that is what we test against.
 
-* ``hvac`` 0.7.0+ (for Azure auth and namespace support)
-* ``hvac`` 0.9.6+ (to avoid most deprecation warnings)
-* ``hvac`` 0.10.5+ (for JWT auth)
-* ``hvac`` 0.10.6+ (to avoid deprecation warning for AppRole)
-* ``hvac`` 0.10.12+ (for cert auth)
+As of ``community.hashi_vault`` version ``5.0.0`` we are setting a minimum supported version of ``hvac``.
+
+**The current required minimum ``hvac`` version is ``1.1.0``.**
 
 Other requirements
 ------------------

diff --git a/tests/utils/constraints.txt b/tests/utils/constraints.txt
@@ -52,7 +52,7 @@ typed-ast == 1.4.0  # 1.4.0 is required to compile on Python 3.8
 wrapt == 1.11.1
 
 # hvac
-hvac >= 0.10.6 ; python_version >= '3.6'
+hvac >= 1.1.0 ; python_version >= '3.6'
 
 # urllib3
 # these should be satisfied naturally by the requests versions required by hvac anyway