Skip to content

Commit

Permalink
Emphasize permitted version format for publication
Browse files Browse the repository at this point in the history
The patch adds mention in README that local version identifiers don’t allow
publishing to PyPI/TestPyPI. Also, it suggests local private index (devpi)
if required to use the local component in versions.

Resolves pypa#322

Co-authored-by: Sviatoslav Sydorenko <webknjaz+github/profile@redhat.com>
  • Loading branch information
OlenaYefymenko and webknjaz committed Apr 28, 2023
1 parent ce7a075 commit 1bc675a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,15 @@ the tag.
For Git projects, the version relies on `git describe <https://git-scm.com/docs/git-describe>`_,
so you will see an additional ``g`` prepended to the ``{revision hash}``.

.. note::

Please remember that if the version includes a local component, it cannot be published
to public package indexes (e.g. PyPI/TestPyPI). These cases (usage of the non-releases)
might arise due to auto-publishing versions or by mistake.

Specific local private indexes, such as ``devpi``, permit local version identifiers, which
comply with `PEP 440 <https://peps.python.org/pep-0440/#local-version-identifiers>`_.
If deemed necessary, make use of them.

Semantic Versioning (SemVer)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 1bc675a

Please sign in to comment.