Skip to content

Commit

Permalink
Add note about specifier not including .dev versions
Browse files Browse the repository at this point in the history
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
  • Loading branch information
pedro-psb authored and mdellweg committed Jan 8, 2024
1 parent 4b6fff4 commit 623a333
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGES/852.doc
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).
6 changes: 6 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 623a333

Please sign in to comment.