From 3d3f172124a15983f144173c6335dddfc41e0827 Mon Sep 17 00:00:00 2001 From: Pedro Brochado Date: Thu, 4 Jan 2024 17:39:30 -0300 Subject: [PATCH] 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 <2500@gmx.de> closes #852 --- CHANGES/852.doc | 1 + docs/architecture.md | 6 ++++++ 2 files changed, 7 insertions(+) create mode 100644 CHANGES/852.doc diff --git a/CHANGES/852.doc b/CHANGES/852.doc new file mode 100644 index 000000000..26a6e1c8e --- /dev/null +++ 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 index 82d6646d5..ab8e4bb2a 100644 --- 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,