Skip to content

Commit 32d0db0

Browse files
petercrockerpetercrocker
authored
Merge pull request #918 from opsmill/pc/add-compatibility-matrix-docs
Add auto-generated compatibility matrix docs
2 parents 70202d4 + 14175cb commit 32d0db0

File tree

7 files changed

+775
-0
lines changed

7 files changed

+775
-0
lines changed

‎docs/_templates/sdk_compatibility.j2‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: Compatibility matrix
3+
---
4+
# Compatibility matrix
5+
6+
This page documents which versions of the Infrahub Python SDK are compatible with each version of Infrahub.
7+
8+
## Version mapping
9+
10+
Each Infrahub release pins a specific SDK version. Using the matching SDK version ensures full compatibility. Newer patch releases of the SDK within the same minor version are generally safe to use.
11+
12+
<!-- vale off -->
13+
| Infrahub | Required SDK | Release date |
14+
| --- | --- | --- |
15+
{% for v in version_ranges %}
16+
| {{ v.infrahub }} | >= {{ v.min_sdk }} | {{ v.date }} |
17+
{% endfor %}
18+
<!-- vale on -->
19+
20+
## Detailed release mapping
21+
22+
The table below shows the exact SDK version pinned to each Infrahub release.
23+
24+
<!-- vale off -->
25+
| Infrahub | SDK version | Infrahub release date |
26+
| --- | --- | --- |
27+
{% for r in release_mappings %}
28+
| {{ r.infrahub }} | {{ r.sdk }} | {{ r.date }} |
29+
{% endfor %}
30+
<!-- vale on -->
31+
32+
## Python version support
33+
34+
<!-- vale off -->
35+
| SDK version | Python versions |
36+
| --- | --- |
37+
{% for p in python_support %}
38+
| {{ p.sdk_range }} | {{ p.python_versions }} |
39+
{% endfor %}
40+
<!-- vale on -->
41+
42+
:::note
43+
The Infrahub server requires Python 3.12 or later. The SDK supports older Python versions so it can be used from environments that do not run the server itself.
44+
:::
45+
46+
## Feature-specific requirements
47+
48+
Some SDK features require a minimum Infrahub version:
49+
50+
<!-- vale off -->
51+
| Feature | Minimum SDK | Minimum Infrahub |
52+
| --- | --- | --- |
53+
{% for f in feature_requirements %}
54+
| {{ f.feature }} | {{ f.min_sdk }} | {{ f.min_infrahub }} |
55+
{% endfor %}
56+
<!-- vale on -->
57+
58+
## General guidance
59+
60+
- **Use the SDK version that matches your Infrahub release.** The version mapping table above shows which SDK version was tested and shipped with each Infrahub release.
61+
- **Patch upgrades within a minor SDK version are safe.** For example, if your Infrahub version pins SDK 1.18.0, upgrading to 1.18.1 is safe.
62+
- **Upgrading to a newer minor SDK version may work** but is not guaranteed. New SDK features may depend on server-side changes that are not present in older Infrahub versions.

‎docs/docs/python-sdk/introduction.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,5 @@ The Infrahub Python SDK greatly simplifies how you can interact with Infrahub pr
3333
## Reference
3434

3535
- [Client configuration](./reference/config.mdx)
36+
- [Compatibility matrix](./reference/compatibility.mdx)
3637
- [Python SDK Release Notes](https://github.com/opsmill/infrahub-sdk-python/releases)

‎docs/docs/python-sdk/reference/compatibility.mdx‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
---
2+
title: Compatibility matrix
3+
---
4+
# Compatibility matrix
5+
6+
This page documents which versions of the Infrahub Python SDK are compatible with each version of Infrahub.
7+
8+
## Version mapping
9+
10+
Each Infrahub release pins a specific SDK version. Using the matching SDK version ensures full compatibility. Newer patch releases of the SDK within the same minor version are generally safe to use.
11+
12+
<!-- vale off -->
13+
| Infrahub | Required SDK | Release date |
14+
| --- | --- | --- |
15+
| 1.8.x | >= 1.19.0 | March 2026 |
16+
| 1.7.x | >= 1.18.1 | January 2026 |
17+
| 1.6.x | >= 1.16.0 | December 2025 |
18+
| 1.5.x | >= 1.15.0 | November 2025 |
19+
| 1.4.x | >= 1.13.5 | August 2025 |
20+
| 1.3.x | >= 1.13.0 | June 2025 |
21+
| 1.2.x | >= 1.8.0 | March 2025 |
22+
| 1.1.x | >= 1.3.0 | December 2024 |
23+
| 1.0.x | >= 1.0.0 | October 2024 |
24+
| 0.16.x | >= 0.13.1 | September 2024 |
25+
<!-- vale on -->
26+
27+
## Detailed release mapping
28+
29+
The table below shows the exact SDK version pinned to each Infrahub release.
30+
31+
<!-- vale off -->
32+
| Infrahub | SDK version | Infrahub release date |
33+
| --- | --- | --- |
34+
| 1.8.4 | 1.19.0 | 2026-04-02 |
35+
| 1.8.3 | 1.19.0 | 2026-03-31 |
36+
| 1.8.2 | 1.19.0 | 2026-03-25 |
37+
| 1.8.1 | 1.19.0 | 2026-03-19 |
38+
| 1.8.0 | 1.19.0 | 2026-03-16 |
39+
| 1.7.7 | 1.18.1 | 2026-03-12 |
40+
| 1.7.6 | 1.18.1 | 2026-02-25 |
41+
| 1.7.5 | 1.18.1 | 2026-02-24 |
42+
| 1.7.4 | 1.18.1 | 2026-02-03 |
43+
| 1.7.3 | 1.18.1 | 2026-01-28 |
44+
| 1.7.2 | 1.18.1 | 2026-01-27 |
45+
| 1.7.1 | 1.18.1 | 2026-01-12 |
46+
| 1.7.0 | 1.18.1 | 2026-01-09 |
47+
| 1.6.3 | 1.17.0 | 2026-01-07 |
48+
| 1.6.2 | 1.17.0 | 2025-12-22 |
49+
| 1.6.1 | 1.17.0 | 2025-12-11 |
50+
| 1.6.0 | 1.16.0 | 2025-12-01 |
51+
| 1.5.5 | 1.15.1 | 2025-12-22 |
52+
| 1.5.4 | 1.15.1 | 2025-12-16 |
53+
| 1.5.3 | 1.15.1 | 2025-11-24 |
54+
| 1.5.2 | 1.15.1 | 2025-11-18 |
55+
| 1.5.1 | 1.15.1 | 2025-11-13 |
56+
| 1.5.0 | 1.15.0 | 2025-11-10 |
57+
| 1.4.13 | 1.13.5 | 2025-11-06 |
58+
| 1.4.12 | 1.13.5 | 2025-10-23 |
59+
| 1.4.11 | 1.13.5 | 2025-10-17 |
60+
| 1.4.10 | 1.13.5 | 2025-10-01 |
61+
| 1.4.9 | 1.13.5 | 2025-09-26 |
62+
| 1.4.8 | 1.13.5 | 2025-09-23 |
63+
| 1.4.7 | 1.13.5 | 2025-09-16 |
64+
| 1.4.6 | 1.13.5 | 2025-09-10 |
65+
| 1.4.5 | 1.14.0 | 2025-09-08 |
66+
| 1.4.4 | 1.13.5 | 2025-09-03 |
67+
| 1.4.3 | 1.13.5 | 2025-08-29 |
68+
| 1.4.2 | 1.13.5 | 2025-08-28 |
69+
| 1.4.1 | 1.13.5 | 2025-08-27 |
70+
| 1.4.0 | 1.13.5 | 2025-08-26 |
71+
| 1.3.9 | 1.13.5 | 2025-09-08 |
72+
| 1.3.8 | 1.13.5 | 2025-08-26 |
73+
| 1.3.7 | 1.13.5 | 2025-08-14 |
74+
| 1.3.6 | 1.13.5 | 2025-08-11 |
75+
| 1.3.5 | 1.13.5 | 2025-08-05 |
76+
| 1.3.4 | 1.13.5 | 2025-07-24 |
77+
| 1.3.3 | 1.13.3 | 2025-07-15 |
78+
| 1.3.2 | 1.13.3 | 2025-06-30 |
79+
| 1.3.1 | 1.13.2 | 2025-06-27 |
80+
| 1.3.0 | 1.13.0 | 2025-06-12 |
81+
| 1.2.12 | 1.12.1 | 2025-06-03 |
82+
| 1.2.11 | 1.12.1 | 2025-05-23 |
83+
| 1.2.10 | 1.12.1 | 2025-05-14 |
84+
| 1.2.9 | 1.12.0 | 2025-05-07 |
85+
| 1.2.8 | 1.12.0 | 2025-05-01 |
86+
| 1.2.7 | 1.11.1 | 2025-04-28 |
87+
| 1.2.6 | 1.10.2 | 2025-04-18 |
88+
| 1.2.5 | 1.10.2 | 2025-04-12 |
89+
| 1.2.4 | 1.10.1 | 2025-04-04 |
90+
| 1.2.3 | 1.10.0 | 2025-04-01 |
91+
| 1.2.2 | 1.9.2 | 2025-03-28 |
92+
| 1.2.1 | 1.9.1 | 2025-03-26 |
93+
| 1.2.0 | 1.8.0 | 2025-03-21 |
94+
| 1.1.10 | 1.7.2 | 2025-04-01 |
95+
| 1.1.9 | 1.7.2 | 2025-03-17 |
96+
| 1.1.8 | 1.7.2 | 2025-03-08 |
97+
| 1.1.7 | 1.7.0 | 2025-02-18 |
98+
| 1.1.6 | 1.7.1 | 2025-01-31 |
99+
| 1.1.5 | 1.7.0 | 2025-01-24 |
100+
| 1.1.4 | 1.6.1 | 2025-01-17 |
101+
| 1.1.3 | 1.6.0 | 2025-01-16 |
102+
| 1.1.2 | 1.5.0 | 2025-01-09 |
103+
| 1.1.1 | 1.4.0 | 2025-01-06 |
104+
| 1.1.0 | 1.3.0 | 2024-12-30 |
105+
| 1.0.10 | 1.1.0 | 2024-12-20 |
106+
| 1.0.9 | 1.1.0 | 2024-12-13 |
107+
| 1.0.8 | 1.1.0 | 2024-12-03 |
108+
| 1.0.7 | 1.0.1 | 2024-11-20 |
109+
| 1.0.6 | 1.0.1 | 2024-11-18 |
110+
| 1.0.5 | 1.0.1 | 2024-11-15 |
111+
| 1.0.4 | 1.0.1 | 2024-11-13 |
112+
| 1.0.3 | 1.0.0 | 2024-11-08 |
113+
| 1.0.2 | 1.0.0 | 2024-11-06 |
114+
| 1.0.1 | 1.0.0 | 2024-10-31 |
115+
| 0.16.4 | 0.14.0 | 2024-10-17 |
116+
| 0.16.3 | 0.14.0 | 2024-10-10 |
117+
| 0.16.2 | 0.13.1 | 2024-10-01 |
118+
| 0.16.1 | 0.13.1 | 2024-09-25 |
119+
<!-- vale on -->
120+
121+
## Python version support
122+
123+
<!-- vale off -->
124+
| SDK version | Python versions |
125+
| --- | --- |
126+
| >= 1.17.0 | 3.10, 3.11, 3.12, 3.13, 3.14 |
127+
| 1.16.0 | 3.10, 3.11, 3.12, 3.13 |
128+
| 1.13.0 - 1.15.x | 3.9, 3.10, 3.11, 3.12, 3.13 |
129+
<!-- vale on -->
130+
131+
:::note
132+
The Infrahub server requires Python 3.12 or later. The SDK supports older Python versions so it can be used from environments that do not run the server itself.
133+
:::
134+
135+
## Feature-specific requirements
136+
137+
Some SDK features require a minimum Infrahub version:
138+
139+
<!-- vale off -->
140+
| Feature | Minimum SDK | Minimum Infrahub |
141+
| --- | --- | --- |
142+
| infrahubctl branch report | 1.19.0 | 1.7 |
143+
| FileObject support | 1.19.0 | 1.8 |
144+
| NumberPool support | 1.13.0 | 1.3 |
145+
<!-- vale on -->
146+
147+
## General guidance
148+
149+
- **Use the SDK version that matches your Infrahub release.** The version mapping table above shows which SDK version was tested and shipped with each Infrahub release.
150+
- **Patch upgrades within a minor SDK version are safe.** For example, if your Infrahub version pins SDK 1.18.0, upgrading to 1.18.1 is safe.
151+
- **Upgrading to a newer minor SDK version may work** but is not guaranteed. New SDK features may depend on server-side changes that are not present in older Infrahub versions.

0 commit comments

Comments
 (0)