Add note about specifier not including .dev versions

When some feature will be added or removed from a plugin, often this should be reflected in the CLI, which requires some special care. Co-authored-by: Matthias Dellweg <[email protected]> closes pulp#852
pedro-psb · Jan 8, 2024 · 3d3f172 · 3d3f172
1 parent eef7051
commit 3d3f172
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/CHANGES/852.doc b/CHANGES/852.doc
@@ -0,0 +1 @@
+Clarified how to handle version specifiers when testing the CLI for unreleased plugin versions (.dev).
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -111,6 +111,12 @@ class PulpMyPluginRepositoryContext(PulpRepositoryContext):
         return body
 ```
 
+!!! note
+    The specifier `>=x.y.z` doesn't include `x.y.z.dev` according to PEP 440.
+    Therefore, when adapting to an unreleased feature change from a plugin, you need to specify the prerelease part of the version explicitly.
+    However `>=x.y.z.dev` is never unambiguous in the current Pulp versioning practice.
+    Once that change is released please reset the constraint to the plain `x.y.z` schema.
+
 ### Generics
 
 For certain often repeated patterns like listing all entities of a particular kind,
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Clarified how to handle version specifiers when testing the CLI for unreleased plugin versions (.dev).