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

Add warning about reference interop for build numbers #1277

Merged
merged 4 commits into from
Aug 3, 2023
Merged

Add warning about reference interop for build numbers #1277

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
036656a
Add warning about reference interop for build numbers
sethmlarson Jul 20, 2023
4d2e9dd
Update source/specifications/binary-distribution-format.rst
sethmlarson Jul 23, 2023
b348a34
Add comment about use-case for build numbers
sethmlarson Jul 26, 2023
67ea0ff
Merge branch 'main' into build-number-interop
sethmlarson Aug 2, 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
17 changes: 17 additions & 0 deletions source/specifications/binary-distribution-format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,23 @@ build tag
the first item being the initial digits as an ``int``, and the
second item being the remainder of the tag as a ``str``.

A common use-case for build numbers is rebuilding a binary
distribution due to a change in the build environment,
like when using the manylinux image to build
distributions using pre-release CPython versions.

.. warning::

Build numbers are not a part of the distribution version and thus are difficult
to reference externally, especially so outside the Python ecosystem of tools and standards.
A common case where a distribution would need to referenced externally is when
resolving a security vulnerability.

Due to this limitation, new distributions which need to be referenced externally
**should not** use build numbers when building the new distribution.
Instead a **new distribution version** should be created for such cases.


language implementation and version tag
E.g. 'py27', 'py2', 'py3'.

Expand Down