Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Emphasize permitted version format in packages for publication #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Emphasize permitted version format in packages for publication #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6c0412
Emphasize permitted version format in packages for publication
OlenaYefymenko May 29, 2023
bcb00a5
Edit typo in README.rst
OlenaYefymenko May 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.rst
View file
Open in desktop
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::

According to `PEP 440 <https://peps.python.org/pep-0440/#local-version-identifiers>`_,
if a version includes a local component, the package cannot be published to public
package indexes like PyPI or TestPyPI. The disallowed version segments may
be seen in auto-publishing workflows or when a configuration mistake is made.

However, some package indexes such as devpi or other alternatives allow local
versions. Local version identifiers must comply with `PEP 440`_.

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